NullifyDocument - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions

Thu Oct 18 13:09:28 BST 2007

POCD_RM130001UK05
ClinicalDocument
The header of the clinical document.
Used by:
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="DOCCLIN" }
Indicates this is a clinical document.
[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }
Indicates this is an event.
[1..1] [M] code (CV {CNE:CDADocumentTypeSnCT } )

A code from the vocabulary shown indicating that this is a Nullification Document.

The Coded with Code System flavour of Coded Value (CV) datatype shall be used to carry this information as follows:

  • The code attribute shall contain the value
  • The codeSystem attribute shall contain the OID for the vocabulary concerned
[1..1] [M] confidentialityCode (CV {CNE:x_BasicConfidentialityKind } ) { Fixed="N" }

A code from the HL7 x_BasicConfidentialityKind vocabulary to denote the level of confidentially applied to the document.


The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information as follows:

  • The code attribute shall contain a fixed value of "N"
  • The codeSystem attribute shall contain the OID of "2.16.840.1.113883.5.25"
  • The displayName attribute will carry a value of "normal"

When this attribute contains a value of "N" ("normal") then the document can be rendered without consulting the relevant centralised ACF service.

The guidance documentation for this domain should be referred to for further information.

[1..1] [M] effectiveTime (TS)
The time at which the document was created. In the format yyyyMMddhhmmss
[1..1] [M] id (II)

This is the unique identifier of the clinical document.

The Identifier Global datatype flavour is used to carry the identifier as follows:

  • The root attribute shall contain a DCE UUID.
[1..1] [M] messageType (II) { Fixed="POCD_MT130001UK05" }

This attribute holds the message type.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.17"
  • The extension attribute shall contain the Message Type ID.
[1..1] [M] setId (II)
Represents an identifier that is common across all document revisions.

The Identifier Global data type flavour is used to carry the identifier as follows:

  • The root attribute shall contain a DCE UUID.
[1..1] [M] title (ST)
This attribute carries the text associated with the SnomedCT code carried in act.code.
[1..1] [M] typeId (II) { Fixed="POCD_HD000040" }
The fixed value of this attribute indicates this is a CDA document.
[1..1] [M] versionNumber (INT)
An integer value used to version successive replacement documents.
[0..1] authenticator
The person who has overall responsibility for the document when the author does not.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="AUTHEN" }
Indicates this is a authenticator.
[1..1] [M] contentId (II) { "NPFIT-000024#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [R] signatureCode (CS {CNE:ParticipationSignature } )

This attribute is only present for CDA compliancy and MUST be set to a null flavor of "NA"

[1..1] [R] time (TS)

The time at which the document was authenticated.

[1..1] participant (AuthenticatorChoice)

A link to a choice of authenticators.

[1..1] [M] author
The author of the clinical document.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="AUT" }
Indicates that this is an author.
[1..1] [M] contextControlCode (CS {CNE:ContextControl } ) { Fixed="OP" }
Specifies how the author contributes to the context of the nullification and whether it may be propagated to descendent acts whose association allows such propagation.

"O" (Overriding)- the association replaces any context of the same or more specific type that has been conducted from the parent act.

"P" (Propagating)- the association is conducted to all child acts where the ActRelationship.contextConductionInd is set to "true."
[1..1] [M] contentId (II) { "NPFIT-000007#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] functionCode (CV {CNE:AuthorFunctionType } ) { Fixed="OA" }

A code from the vocabulary shown indicating the function of the document author

The Coded Plain flavour of Coded Value (CV) datatype shall be used to carry this information as follows:

  • The code attribute shall contain the value
  • The codeSystem attribute shall contain the OID for the vocabulary concerned
  • The displayName attribute shall contain the text associated with the code
[1..1] [M] time (TS)
The time which the author authored the clinical document.
[1..1] [M] participant (AuthorChoice)
A link to the choice of author.
[1..1] [M] component
Refers to a component of the header of the CDA document.
[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="COMP" }
Indicates this is a component.
[1..1] [M] contextConductionInd (BL) { Fixed="true" }
If true, associations in the parent act are conducted across the ActRelationship to the child act.
[1..1] [M] structuredBody (StructuredBody)
A link to the structured body part of the CDA document.
[1..1] [M] custodian
The custodian of the CDA document.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="CST" }
Indicates that this is a custodian.
[1..1] [M] contentId (II) { "NPFIT-000014#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] participant (CustodianChoice)

A link to the patient templates

[0..1] dataEnterer
Refers to the person who entered the information contained in the document.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="ENT" }
Indicates this is a dataEnterer
[1..1] [M] contextControlCode (CS {CNE:ContextControl } ) { Fixed="OP" }

Specifies how the dataEnterer contributes to the context of the Nullify document and whether it may be propagated to descendent acts whose association allows such propagation.

"O" (Overriding)- the association replaces any context of the same or more specific type that has been conducted from the parent act.

"P" (Propagating)- the association is conducted to all child acts where the ActRelationship.contextConductionInd is set to "true."
[1..1] [M] contentId (II) { "NPFIT-000016#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] participant (DataEntererChoice)
A link to the choice of role templates.
[1..*] [M] informationRecipient
The primary information recipients of the clinical document.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="PRCP" }
Indicates that this is a primary information recipient.
[1..1] [M] contentId (II) { "NPFIT-000008#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] participant (RecipientChoice)
A link to the choice of information recipients.
[1..1] [M] recordTarget
The patient who's record is the target for the information in the Document.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="RCT" }

Indicates that this is the record target of the clinical document.

[1..1] [M] contextControlCode (CS {CNE:ContextControl } ) { Fixed="OP" }

Specifies how this participation contributes to the context of the current act and whether it may be propagated to descendent acts whose association allows such propagation.

"O" (Overriding)- the association replaces any context of the same or more specific type that has been conducted from the parent act.

"P" (Propagating)- the association is conducted to all child acts where the ActRelationship.contextConductionInd is set to "true."
[1..1] [M] contentId (II) { "NPFIT-000019#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] participant (Patient)

A link to the patient templates

[1..1] [M] relatedDocument
Refers to the document that is being replaced.
[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="RPLC" }
Indicates this is a replacement.
[1..1] [M] priorParentDocument (ParentDocument)
A link to the Parent Document.
[0..*] tracker
A tracker i.e. a copy recipient.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="TRC" }
Indicates that this is a tracker.
[1..1] [M] contentId (II) { "NPFIT-000008#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] participant (RecipientChoice)
A link to the choice of trackers.
CustodianChoice

An abstract placeholder for the templates of an custodian.

Used by: ClinicalDocument
[1..1] either : Template4
A link to the custodian templates.
RecipientChoice

An abstract placeholder for the templates of a recipient.

Used by: ClinicalDocument
[1..1] either : Template2

A link to the recipient templates.

AuthorChoice

An abstract choice of allowable templates for the author of the CDA document.

Used by: ClinicalDocument
[1..1] either : Template3

A link to the author templates.

Patient

An abstract placeholder for the templates of a patient.

Used by: ClinicalDocument
[1..1] either : Template6

A link to the patient role templates

StructuredBody
Indicates this is the body of the CDA document.
Used by: ClinicalDocument
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="DOCBODY" }
Indicates this is the body of the CDA document.
[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }
Indicates this is an event.
[1..1] [M] component

A link to the component(s) of the structured body.

[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="COMP" }

Indicates that this is a component.

[1..1] [M] contextConductionInd (BL) { Fixed="true" }

If true, associations in the parent act are conducted across the ActRelationship to the child act.

[1..1] [M] classificationSection (ClassificationSection)
ClassificationSection

A section which is not rendered but is used to hold the coded entries and CRE classification in one place for ease of processing.

Used by: StructuredBody
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="DOCSECT" }

Indicates this is a Document Section

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }

Indicates this is an event

[1..1] [M] id (II)

This is the unique identifier of the classification section.

The Identifier Global datatype flavour is used to carry the identifier as follows:

  • The root attribute shall contain a DCE UUID.
[1..1] [M] component
A link to the component(s) of the structured body.
[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="COMP" }
Indicates that this is a component.
[1..1] [M] contextConductionInd (BL) { Fixed="true" }

If true, associations in the parent act are conducted across the ActRelationship to the child act.

[1..1] [M] contentId (II) { "NPFIT-000001#Section" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] sectionChoice (SectionChoice)
A link to the CDA section choice.
[1..1] [M] entry

Refers to the CDA coded entries

[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="COMP" }

Indicates that this is a component.

[1..1] [M] contextConductionInd (BL) { Fixed="true" }

If true, associations in the parent act are conducted across the ActRelationship to the child act.

[1..1] [M] contentId (II) { "NPFIT-000017#Section" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] codedEntry (CodedEntry)

A link to the coded entry templates.

[0..*] entry1

Refers to the CRE type entry.

[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="COMP" }

Indicates that this is a component.

[1..1] [M] contextConductionInd (BL) { Fixed="true" }

If true, associations in the parent act are conducted across the ActRelationship to the child act.

[1..1] [M] contentId (II) { "NPFIT-000032#Section" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] cRETypeListChoice (CRETypeListChoice)

A link to the CRE type templates

SectionChoice
An abstract choice of allowable templates for the Section part of the CDA document.
Used by: ClassificationSection
[1..1] either : Template9
CodedEntry

The coded entries of the CDA document.

Used by: ClassificationSection
[1..1] either : Template

A link to the coded entry templates.

CRETypeListChoice

An abstract placeholder for the templates of a CRE type list.

Used by: ClassificationSection
[1..1] either : Template10

A link to the CRE type list templates

ParentDocument
A related CDA document which is being referenced.
Used by: ClinicalDocument
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="DOCCLIN" }
Indicates this is a clinical document.
[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }
Indicates this is an event.
[1..1] [M] code (CV {CNE:CDADocumentTypeSnCT } )

A code from the vocabulary shown indicating the type of document.

The Coded with Code System flavour of Coded Value (CV) datatype shall be used to carry this information as follows:

  • The code attribute shall contain the value
  • The codeSystem attribute shall contain the OID for the vocabulary concerned
[1..1] [M] id (II)

The UUID of the CDA document being referenced when the document is being replaced.

The Identifier Global datatype flavour is used to carry the identifier as follows:

  • The root attribute shall contain a DCE UUID.
[1..1] [M] setId (II)
Represents an identifier that is common across all document revisions.

The Identifier Global data type flavour is used to carry the identifier as follows:

  • The root attribute shall contain a DCE UUID.
[1..1] [M] versionNumber (INT)
The integer version number of the document being referenced.
AuthenticatorChoice

An abstract placeholder for the templates of a Authenticator.

Used by: ClinicalDocument
[1..1] either : Template7

A link to the authenticator templates.

DataEntererChoice

An abstract placeholder for the templates of a data enterer role.

Used by: ClinicalDocument
[1..1] either : Template5

A link to the data enterer role templates