#### Nullification
Domain Message Specification

### NullifyDocument Tabular View

POCD_RM130001UK05 |
ClinicalDocument | This class is a clinical document class. This class and its participations are commonly known as the header of the CDA document.
| Used by:
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="DOCCLIN" } | Model Attribute Description The HL7 attribute classCode uses a code to describe this class as a clinical document. Implementation in XML Instance The XML attribute classCode is fixed to " DOCCLIN".
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } | Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as a clinical document event Implementation in XML Instance The XML attribute moodCode is fixed to " EVN".
[1..1] [M] code (CV { CNE:CDADocumentTypeSnCT } ) { Fixed="285091000000108" } | Model Attribute Description The HL7 attribute code uses a code from SNOMED CT to describe the type of CDA document as a nullification document. Implementation in XML Instance The Coded with Code System flavour of Coded Value (CV) shall be used to carry this information in the XML element code as follows: The XML attribute code shall contain the fixed value "285091000000108" The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
[1..1] [M] confidentialityCode (CV { CNE:x_BasicConfidentialityKind } ) { Default="N" } | Model Attribute Description The HL7 attribute confidentiality code uses a code from any vocabulary to describe the confidentiality of the CDA document. This may be implemented using NHS CFH sealing or some form of locally agreed access control. Implementation in XML Instance When implementing NHS CFH Sealing then: 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 in the XML element confidentialityCode as follows: The XML attribute code shall contain a fixed value of "V" The XML attribute codeSystem shall contain the OID of "2.16.840.1.113883.1.11.16926" The XML attribute displayName shall carry a value of "very restricted" When this attribute contains a value of "V" ("very restricted") then the relevant centralised ACF service must be consulted prior to rendering to any user. Otherwise it shall be populated with: Either 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 in the XML element confidentialityCode as follows: The XML attribute code shall contain a value from the stated HL7 vocabulary The XML attribute codeSystem shall contain the OID of "2.16.840.1.113883.1.11.16926" The XML attribute displayName shall carry the description associated with the code These codes should be populated and processed as appropriate for the local requirement for controlling access to the information. Or A code from an alternative locally agreed 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 in the XML element confidentialityCode as follows: The XML attribute code shall contain a value from the vocabulary The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.415" The XML attribute displayName shall carry a value associated with the code These codes should be populated and processed as appropriate for the local requirement for controlling access to the information.
[1..1] [M] effectiveTime (TS) | Model Attribute Description The HL7 attribute effectiveTime is used to define the creation time of the CDA document. Implementation in XML Instance The XML attribute value of the XML element effectiveTime shall be populated with the time the document was created using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where: yyyy is the year mm is the month dd is the day hh is the hour mm is the minutes ss is the seconds [+|-ZZzz] is the time zone offset in hours and minutes Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.
[1..1] [M] id (II) | Model Attribute Description The HL7 attribute id uses an identifier to identify each unique instance of a clinical document. Implementation in XML Instance The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows: The XML attribute root shall contain a DCE UUID
[1..1] [M] messageType (II) { Fixed="POCD_MT130001UK05" } | Model Attribute Description The HL7 (NHS localisation) attribute messageType identifies the CDA document as one that complies with a certain NHS CDA profile. The value of this attribute provides a unique identifier for the profile in question. Implementation in XML Instance The XML element messageType is populated as follows The XML attribute root shall carry the OID "2.16.840.1.113883.2.1.3.2.4.18.17" The XML attribute extension shall carry the value "POCD_MT130001UK05"
[1..1] [M] setId (II) | Model Attribute Description The HL7 attribute setId uses an identifier to identify all documents that are part of a set of documents. Implementation in XML Instance The Identifier Global data type flavour is used to carry the identifier in the XML element setId as follows: The XML attribute root shall contain a DCE UUID
[1..1] [M] title (ST) | Model Attribute Description The HL7 attribute title uses a string which is rendered as a human readable title. Implementation in XML Instance The XML element title shall contain the value " Nullification Document".
[1..1] [M] typeId (II) { Fixed="POCD_HD000040" } | Model Attribute Description The HL7 attribute typeId signals the imposition of constraints defined in an HL7-specified message type. The typeId is used to indicate this is a CDA document that complies with CDA R2. Implementation in XML Instance The XML element typeId is populated as follows: The XML attribute root shall carry the OID "2.16.840.1.113883.1.3" The XML attribute extension shall carry the value "POCD_HD000040"
[1..1] [M] versionNumber (INT) | Model Attribute Description The HL7 attribute versionNumber uses an integer value to allow versioning of the CDA document. The version number here is the version number of this document. Implementation in XML Instance The XML element versionNumber is populated as follows: The XML attribute value should contain the version number of the document as an integer value Note this should be the version of the document being nullified + 1
[0..1] authenticator | This class is a participation of authentication. It is used for participations where the CDA document needs to be authenticated. This means that the person who authenticated will have overall responsibility for the document not the author. For example a supervisor.
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="AUTHEN" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as an authenticator participation. Implementation in XML Instance The XML attribute classCode is fixed to " AUTHEN".
[1..1] [M] contentId (II) { "NPFIT-800024#Role" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] [R] signatureCode (CS { CNE: ParticipationSignature } ) | Model Attribute Description The HL7 attribute signatureCode uses a code to describe signature for the CDA document. This attribute is currently not used for NHS CDA implementations and should be nulled. Implementation in XML Instance The XML attribute nullFlavor of the XML element signatureCode shall contain the value " NA".
[1..1] [R] time (TS) | Model Attribute Description The HL7 attribute authenticator time is used to indicate when the person authenticated the CDA document. Implementation in XML Instance The XML attribute value of the XML element time, shall be populated with a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where: yyyy is the year mm is the month dd is the day hh is the hour mm is the minutes ss is the seconds [+|-ZZzz] is the time zone offset in hours and minutes Sections from the right of this representation may be left off to when the sending system does not record to this accuracy. When hours are present, the time zone offset must also be present. When the time of authentication is not available to the sending system then: The XML attribute nullFlavor of the XML element time shall contain the value "NI"
[1..1] participant (AuthenticatorChoice) | A link to a choice of authenticator templates.
[1..1] [M] author | This class is a participant of authorship. It holds details of how and when the author authored the CDA document.
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="AUT" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as an author participation. Implementation in XML Instance The XML attribute classCode is fixed to " AUT".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } ) { Fixed="OP" } | Model Attribute Description The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section is conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct. The conduction can only take place if the contextConductionInd is set to "true". The value of this attribute is fixed in the HL7 model to "OP": "O" (Overriding)- the author replaces any author that has been conducted from any previous acts "P" (Propagating)- the author is conducted to all child acts where the contextConductionInd is set to "true" Implementation in XML Instance The XML attribute contextControlCode shall contain the value " OP".
[1..1] [M] contentId (II) { "NPFIT-800007#Role" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] [M] functionCode (CV { CNE:AuthorFunctionType } ) { Fixed="OA" } | Model Attribute Description The HL7 attribute functionCode uses a code from the vocabulary AuthorFunctionType to describe the function of the author. Implementation in XML Instance The Coded Plain flavour of Coded Value (CV) datatype shall be used to carry this information in the XML element functionCode as follows: The XML attribute code shall contain the value "OA" The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.178" The XML attribute displayName will contain the value "Originating Author"
[1..1] [M] time (TS) | Model Attribute Description The HL7 attribute author time is used to indicate when the person authored the CDA document. Implementation in XML Instance The XML attribute value of the XML element time, shall be populated with a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where: yyyy is the year mm is the month dd is the day hh is the hour mm is the minutes ss is the seconds [+|-ZZzz] is the time zone offset in hours and minutes Sections from the right of this representation may be left off to when the sending system does not record to this accuracy. When hours are present, the time zone offset must also be present.
[1..1] [M] participant (AuthorChoice) | A link to the choice of author templates.
[1..1] [M] component | This class is an component. It links the CDA header to the choice of CDA bodies.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a component. Implementation in XML Instance The XML attribute typeCode is fixed to " COMP".
[1..1] [M] contextConductionInd (BL) { Fixed="true" } | Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section). Implementation in XML Instance The XML attribute contextConductionInd is fixed to " true".
[1..1] [M] structuredBody (StructuredBody) | A link to the structured body.
[1..1] [M] custodian | A class which is a participation of custodian. The custodian is the legal owner of the CDA document and is the organisation responsible for maintaining the information in the CDA document.
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="CST" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a custodian participation. Implementation in XML Instance The XML attribute classCode is fixed to " CST".
[1..1] [M] contentId (II) { "NPFIT-800014#Role" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] [M] participant (CustodianChoice) | A link to the custodian templates.
[0..1] dataEnterer | This class is a data enterer participation. A data enterer is the person who entered the information contained in the document.
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="ENT" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this participation as a data enterer. Implementation in XML Instance The XML attribute typeCode is fixed to " ENT".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } ) { Fixed="OP" } | Model Attribute Description The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section is conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct. The conduction can only take place if the contextConductionInd is set to "true". The value of this attribute is fixed in the HL7 model to "OP": "O" (Overriding)- the data enterer replaces any data enterer that has been conducted from any previous acts "P" (Propagating)- the data enterer is conducted to all child acts where the contextConductionInd is set to "true" Implementation in XML Instance The XML attribute contextControlCode shall contain the value " OP".
[1..1] [M] contentId (II) { "NPFIT-800016#Role" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] participant (DataEntererChoice) | A link to the choice of data enterer templates.
[1..*] [M] informationRecipient | This class is a primary information recipient participation. The primary information recipients of the clinical documents are usually expected to perform some action on receipt of a CDA document. There can be more than one primary recipient.
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="PRCP" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a primary information recipient participation. Implementation in XML Instance The XML attribute classCode is fixed to " PRCP".
[1..1] [M] contentId (II) { "NPFIT-800008#Role" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] [M] participant (RecipientChoice) | A link to the choice of primary information recipient templates.
[1..1] [M] recordTarget | A class which is a participation of record target (the patient whose record is the target for the information in the document).
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="RCT" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a record target participation. Implementation in XML Instance The XML attribute classCode is fixed to " RCT".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } ) { Fixed="OP" } | Model Attribute Description The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section is conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct. The conduction can only take place if the contextConductionInd is set to "true". The value of this attribute is fixed in the HL7 model to "OP": "O" (Overriding)- the record target replaces any record target that has been conducted from any previous acts "P" (Propagating)- the record target is conducted to all child acts where the contextConductionInd is set to "true" Implementation in XML Instance The XML attribute contextControlCode shall contain the value " OP".
[1..1] [M] contentId (II) { "NPFIT-800019#Role" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] [M] participant (Patient) | A link to the patient role templates.
[1..1] [M] relatedDocument | This class is a related document relationship it links the current document to a related CDA document.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="RPLC" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe the type of relationship as one of replacement. Implementation in XML Instance The XML attribute typeCode is fixed to " RPLC".
[1..1] [M] priorParentDocument (ParentDocument) | A link to the parent document.
[0..*] tracker | This class is a tracker participation. A tracker is a recipient who is sent a copy of the CDA document for information only. They are not normally required to carry out any action on receipt of the CDA document.
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="TRC" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this participation as a tracker. Implementation in XML Instance The XML attribute typeCode is fixed to " TRC".
[1..1] [M] contentId (II) { "NPFIT-800008#Role" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] participant (RecipientChoice) | A link to the choice of tracker templates.
CustodianChoice | An abstract placeholder for the templates of a custodian.
| Used by: ClinicalDocument
[1..1] : Template4 | A link to templates for a custodian.
RecipientChoice | An abstract placeholder for templates of a recipient.
| Used by: ClinicalDocument
[1..1] : Template2 | A link to templates for a recipient.
AuthorChoice | An abstract placeholder for the templates for an author.
| Used by: ClinicalDocument
[1..1] : Template3 | A link to templates for an author.
Patient | An abstract placeholder for the templates of a patient.
| Used by: ClinicalDocument
[1..1] : Template6 | A link to templates for a patient.
StructuredBody | The StructuredBody represents a CDA document body that is comprised of one or more document sections.
| Used by: ClinicalDocument
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="DOCBODY" } | Model Attribute Description The HL7 attribute classCode uses a code to describe this class as a clinical document body. Implementation in XML Instance The XML attribute classCode is fixed to " DOCBODY".
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } | Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as a clinical document body event. Implementation in XML Instance The XML attribute moodCode is fixed to " EVN".
[1..1] [M] component | This class is a component of a section (a section the nests within another section).
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a component. Implementation in XML Instance The XML attribute typeCode is fixed to " COMP".
[1..1] [M] contextConductionInd (BL) { Fixed="true" } | Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section). Implementation in XML Instance The XML attribute contextConductionInd is fixed to " true".
[1..1] [M] classificationSection (ClassificationSection) | A link to the classification section.
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" } | Model Attribute Description The HL7 attribute classCode uses a code to describe this class document section. Implementation in XML Instance The XML attribute classCode is fixed to " DOCSECT".
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } | Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as a document event. Implementation in XML Instance The XML attribute classCode is fixed to " EVN".
[1..1] [M] id (II) | Model Attribute Description The HL7 attribute id uses an identifier to identify each instance of a classification section. Implementation in XML Instance The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows: The XML attribute root shall contain a DCE UUID
[1..1] [M] component | This class is a component. It links the classification section to the section choice.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a component. Implementation in XML Instance The XML attribute classCode is fixed to " COMP".
[1..1] [M] contextConductionInd (BL) { Fixed="true" } | Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section). Implementation in XML Instance The XML attribute contextConductionInd is fixed to " true".
[1..1] [M] contentId (II) { "NPFIT-800001#Section" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] [M] sectionChoice (SectionChoice) | A link to the choice of sections.
[1..1] [M] entry | This class is a entry component. It links the classification section to the coded entries.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a component. Implementation in XML Instance The XML attribute typeCode is fixed to " COMP".
[1..1] [M] contextConductionInd (BL) { Fixed="true" } | Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section). Implementation in XML Instance The XML attribute contextConductionInd is fixed to " true".
[1..1] [M] contentId (II) { "NPFIT-800017#Section" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] [M] codedEntry (CodedEntry) | A link to the coded entries.
[0..*] entry1 | This class is a entry component. It links the classification section to the CRE type list.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } | Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a component. Implementation in XML Instance The XML attribute typeCode is fixed to " COMP".
[1..1] [M] contextConductionInd (BL) { Fixed="true" } | Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section). Implementation in XML Instance The XML attribute contextConductionInd is fixed to " true".
[1..1] [M] contentId (II) { "NPFIT-800032#Section" } | Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element contentId as follows: The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16" The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] cRETypeListChoice (CRETypeListChoice) | A link to the CRE type list.
SectionChoice | An abstract placeholder for the templates of a section.
| Used by: ClassificationSection
[1..1] : Template9 | A link to the choice of section templates.
CodedEntry | An abstract placeholder for the templates of a coded entry.
| Used by: ClassificationSection
[1..1] : Template | A link to templates for coded entries.
CRETypeListChoice | An abstract placeholder for the templates for CRE type lists.
| Used by: ClassificationSection
[1..1] : Template10 | A link to templates for a CRE type list.
ParentDocument | A related CDA document which is being referenced as the document being nullified (replaced).
| Used by: ClinicalDocument
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="DOCCLIN" } | Model Attribute Description The HL7 attribute classCode uses a code to describe this class as a clinical document. Implementation in XML Instance The XML attribute classCode is fixed to " DOCCLIN".
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } | Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as a clinical document event Implementation in XML Instance The XML attribute moodCode is fixed to " EVN".
[1..1] [M] code (CV { CWE:CDADocumentTypeSnCT } ) | Model Attribute Description The HL7 attribute code uses a code from SNOMED CT to describe the type of CDA document. There are two possible representations for this attribute: A single code from SNOMED CT A composition grammar using multiple SNOMED CT codes Note: Where the document being replaced (nullified) was not described using a code from SNOMED CT then other coding systems may be used instead. Implementation in XML Instance When using a single SNOMED CT code then: The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows: The XML attribute code shall contain a code from the subset stated in CDADocumentTypeSnCT vocabulary The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15" The XML attribute displayName may carry a description associated with the code in the subset stated in the CDADocumentTypeSnCT vocabulary. It is recommended that the preferred term is used to populate this attribute When using multiple SNOMED CT codes then: The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows: The XML attribute code shall contain a string composed from codes from the subsets stated in CDADocumentTypeSnCT vocabulary as per the guidance in the vocabulary The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15.1" The XML attribute displayName may contain a string composed from the codes and descriptions from the subsets stated in CDADocumentTypeSnCT vocabulary as per the guidance in the vocabulary Note: When the document being nullified was not coded using SNOMED CT then: The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows: The XML attribute code shall contain the code used to code the document The XML attribute codeSystem shall contain the OID for the code system The XML attribute displayName may carry a description associated with the code
[1..1] [M] id (II) | Model Attribute Description The HL7 attribute id uses an identifier to identify each unique instance of a parent clinical document. Implementation in XML Instance The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows: The XML attribute root shall contain a DCE UUID of the document being replaced (nullified)
[1..1] [M] setId (II) | Model Attribute Description The HL7 attribute setId uses an identifier to identify all documents that are part of a set of documents. Implementation in XML Instance The Identifier Global data type flavour is used to carry the identifier in the XML element setId as follows: The XML attribute root shall contain a DCE UUID
[1..1] [M] versionNumber (INT) | Model Attribute Description The HL7 attribute versionNumber uses an integer value to allow versioning of the CDA document. The version number here is the version number of the parent document that is being nullified. Implementation in XML Instance The XML element versionNumber is populated as follows: The XML attribute value should contain the version number of the parent document being nullified as an integer value Systems should nullify the version of the document carried here and any previous versions of the document stored on the system.
AuthenticatorChoice | An abstract placeholder for the templates for an authenticator.
| Used by: ClinicalDocument
[1..1] : Template7 | A link to templates for an authenticator.
DataEntererChoice | An abstract placeholder for the templates of a data enterer.
| Used by: ClinicalDocument
[1..1] : Template5 | A link to templates for a data enterer.