Templates

Show index

Template Non-Human Subject - subject Containment 2019‑08‑20

Id2.16.756.5.30.1.1.10.4.5
ref
ch-palm-
Effective Date2019‑08‑20
Statusactive ActiveVersion Label2019
Namechpalm_entry_NonHumanSubjectDisplay NameNon-Human Subject - subject Containment
Description
If, in a part of the document, laboratory obseravtions base exclusively on a sample of a non-human material (e.g., animal, water, soil, etc.) without reference to a patient, it MUST be declared using this element in the CDA body.
The non-human subject SHALL also be represented in the CDA header by using the IHE template "Non-Human Subject" (1.3.6.1.4.1.19376.1.3.3.1.2).
ContextSibling nodes of template element with id 2.16.756.5.30.1.1.10.4.5
LabelIHE PalM TF3 Rev.10, 6.3.4.3
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 3 transactions and 13 templates, Uses 1 template
Used by as NameVersion
2.16.756.5.30.1.127.77.1.4.5Transactionpending CDA-CH-VACD - Immunization Recommendation Request (2018)2018‑04‑10 18:08:44
2.16.756.5.30.1.127.77.1.4.6Transactionpending CDA-CH-VACD - Immunization Recommendation Response (2018)2018‑04‑10 18:09:59
2.16.756.5.30.1.127.77.1.4.7Transactionpending CDA-CH-VACD - Vaccination Record (2018)2018‑04‑10 18:10:49
2.16.756.5.30.1.1.10.1.17linkactive Immunization Recommendation Request (2020)2020‑06‑26
2.16.756.5.30.1.1.10.1.18linkactive Immunization Recommendation Response (2020)2020‑06‑26
2.16.756.5.30.1.1.10.1.19linkactive Vaccination Record (2020)2020‑06‑26
2.16.756.5.30.1.1.10.3.3linkactive Laboratory Speciality Section - coded (2019)2019‑08‑20
2.16.756.5.30.1.1.10.3.5linkactive Laboratory Report Item Section - coded (2019)2019‑08‑20
2.16.756.5.30.1.1.10.4.3linkactive Laboratory Observation (2020)2019‑08‑20
2.16.756.5.30.1.1.10.4.4Containmentactive Laboratory Report Data Processing Entry (2019)2019‑08‑20
2.16.756.5.30.1.1.10.4.11linkactive Specimen Collection (2019)2019‑08‑20
2.16.756.5.30.1.1.10.4.17Containmentactive Laboratory Isolate Organizer (2019)2019‑08‑20
2.16.756.5.30.1.1.10.4.19Containmentactive Laboratory Battery Organizer (2019)2019‑08‑20
2.16.756.5.30.1.1.10.4.85Containmentactive Laboratory Isolate Organizer - Pathogen Detection (2020)2020‑06‑26
2.16.756.5.30.1.1.10.4.87Containmentactive Laboratory Battery Organizer - Antibiogram (2020)2020‑06‑26
2.16.756.5.30.1.1.10.4.118Containmentactive Laboratory Report Data Processing Entry (2020)2020‑06‑26
Uses as NameVersion
2.16.756.5.30.1.1.10.9.49Includedraft Original Text Reference (2021)DYNAMIC
RelationshipSpecialization: template 2.16.840.1.113883.10.12.320 CDA Subject (Body) (2005‑09‑07)
ref
ad1bbr-

Specialization: template 1.3.6.1.4.1.19376.1.3.3.1.2.1 Non-Human Subject (DYNAMIC)
ref
XDLAB-
Example
XD-LAB example
<subject>
  <templateId root="2.16.756.5.30.1.1.10.4.5"/>  <templateId root="1.3.6.1.4.1.19376.1.3.3.1.2.1"/>  <relatedSubject>
    <code code="226955001" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Chicken">
      <qualifier>
        <name code="105590001" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Substance"/>        <value code="255620007" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Food"/>      </qualifier>
    </code>
    <addr>
      <streetAddressLine>304 Portola Road</streetAddressLine>      <city>San Jose</city>      <state>CA</state>      <postalCode>95120</postalCode>      <country>USA</country>    </addr>
  </relatedSubject>
</subject>
Example
Water specimen from a reservoir
<subject>
  <templateId root="2.16.756.5.30.1.1.10.4.5"/>  <templateId root="1.3.6.1.4.1.19376.1.3.3.1.2.1"/>  <relatedSubject>
    <code code="257687008" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Reservoir (environment)">
      <qualifier>
        <name code="105590001" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Substance"/>        <value code="229979003" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="General food and drink types"/>      </qualifier>
    </code>
    <addr>
      <streetAddressLine>Wasserversorgung Gemeindeverband Musterhausen</streetAddressLine>      <streetAddressLine>Reservoir Waldrand</streetAddressLine>      <postalCode>8888</postalCode>      <city>Musterhausen</city>    </addr>
  </relatedSubject>
</subject>
ItemDTCardConfDescriptionLabel
hl7:templateId
II1 … 1MIHE PalM TF3 Rev.10, 6.3.4.3
@root
uid1 … 1F2.16.756.5.30.1.1.10.4.5
hl7:templateId
II1 … 1MIHE PalM TF3 Rev.10, 6.3.4.3
@root
uid1 … 1F1.3.6.1.4.1.19376.1.3.3.1.2.1
hl7:relatedSubject
1 … 1RIHE PalM TF3 Rev.10, 6.3.4.3
hl7:code
CE1 … 1The type of the non-human subject (animal species, food, material from nature, etc.) MUST be declared using a Code. LOINC (2.16.840.1.113883.6.1) or SNOMED CT (2.16.840.1.113883.6.96) codes or values from the HL7 Vocabulary ObservationType (2.16.840.1.113883.1.11.16226) SHOULD be used.
If no vocabulary is available, nullFlavor='OTH' including an originalText element MUST be used. In this case, the attributes @code, @codeSystem and @codeSystemName are NOT ALLOWED.
IHE PalM TF3 Rev.10, 6.3.4.3
@nullFlavor
cs0 … 1FASKU
 If no vocabulary is available, nullFlavor='ASKU' including a displayName MUST be used.
@code
cs0 … 1 The code MUST be specified.
@codeSystem
oid0 … 1 The OID of the code system MUST be specified.
@codeSystemName
st0 … 1 The name of the code system MUST be specified for tracking purposes. However, processing is NOT ALLOWED.
@displayName
st0 … 1 The displayName of the code MUST be specified for tracking purposes. However, processing is NOT ALLOWED. Instead, a processing system is to display a user readable language translation of the code from the value set.
Included0 … 1C from 2.16.756.5.30.1.1.10.9.49 Original Text Reference (DYNAMIC)
The human-readable text MUST be generated automatically from the structured information of this element. The text element MUST contain the reference to the corresponding text in the human readable part, ONLY.
hl7:originalText
ED0 … 1CCDA‑CH V2
hl7:reference
TEL1 … 1MThe reference to the corresponding text in the human readable part must be specified by reference to content[@ID]: reference[@value='#xxx']CDA‑CH V2
@value
1 … 1RReference to the narrative part of the section in the format '#xxx', where xxx is the ID of the corresponding element.
 Schematron assertrolered error 
 teststarts-with(@value,'#') 
 MessageThe @value attribute content MUST conform to the format '#xxx', where xxx is the ID of the corresponding 'content' element. 
 Variable letNameidvalue 
 Valuesubstring-after(@value,'#') 
 Schematron assertrolered error 
 testancestor::hl7:structuredBody//*[@ID=$idvalue] 
 MessageNo narrative text found for this reference (no content element within this document has an ID that corresponds to '<value-of select="$idvalue"/>'). 
 Schematron assertrolered error 
 testparent::*/text()=ancestor::hl7:structuredBody//*[@ID=$idvalue]/text() 
 MessageThe originalText content MUST be identical to the narrative text for this reference. 
 Schematron assertrolered error 
 test(@code and @codeSystem) or (@nullFlavor='OTH' and hl7:originalText) 
 MessageEither a code with its code system or nullFlavor='OTH' with an originalText element is required. 
hl7:addr
AD1 … 1The address is where the material was located, from which the sample was taken. If it is not known, nullFavor='UNK' MUST be used.IHE PalM TF3 Rev.10, 6.3.4.3

Template Non-Human Subject - subject Containment 2017‑06‑21

Id2.16.756.5.30.1.1.10.4.5
ref
ch-palm-
Effective Date2017‑06‑21
Statusrejected RejectedVersion Label2017
Namechpalm_entry_NonHumanSubjectDisplay NameNon-Human Subject - subject Containment
Description
If, in a part of the document, laboratory obseravtions base exclusively on a sample of a non-human material (e.g., animal, water, soil, etc.) without reference to a patient, it MUST be declared using this element in the CDA body.
Other parts of the document may contain laboratory observations that base on other samples (including samples taken from the patient).
In addition, the IHE template 1.3.6.1.4.1.19376.1.3.3.1.2 - Non-Human Subject (recordTarget) MUST be used in the CDA header.
ContextSibling nodes of template element with id 2.16.756.5.30.1.1.10.4.5
LabelIHE PalM TF3 Rev.8, 6.3.4.3
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
RelationshipSpecialization: template 2.16.840.1.113883.10.12.320 CDA Subject (Body) (2005‑09‑07)
ref
ad1bbr-

Specialization: template 1.3.6.1.4.1.19376.1.3.3.1.2.1 Non-Human Subject (DYNAMIC)
ref
XDLAB-
Example
XD-LAB example
<subject>
  <cda:templateId root="2.16.756.5.30.1.1.10.4.5"/>  <cda:templateId root="1.3.6.1.4.1.19376.1.3.3.1.2.1"/>  <relatedSubject>
    <code code="226955001" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Chicken">
      <qualifier>
        <name code="105590001" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Substance"/>        <value code="255620007" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Food"/>      </qualifier>
    </code>
    <addr>
      <streetAddressLine>304 Portola Road</streetAddressLine>      <city>San Jose</city>      <state>CA</state>      <postalCode>95120</postalCode>      <country>USA</country>    </addr>
  </relatedSubject>
</subject>
Example
Water specimen from a reservoir
<subject>
  <cda:templateId root="2.16.756.5.30.1.1.10.4.5"/>  <cda:templateId root="1.3.6.1.4.1.19376.1.3.3.1.2.1"/>  <relatedSubject>
    <code code="257687008" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Reservoir (environment)">
      <qualifier>
        <name code="105590001" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Substance"/>        <value code="229979003" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="General food and drink types"/>      </qualifier>
    </code>
    <addr>
      <streetAddressLine>Wasserversorgung Gemeindeverband Musterhausen</streetAddressLine>      <streetAddressLine>Reservoir Waldrand</streetAddressLine>      <postalCode>8888</postalCode>      <city>Musterhausen</city>    </addr>
  </relatedSubject>
</subject>
ItemDTCardConfDescriptionLabel
hl7:templateId
II1 … 1MIHE PalM TF3 Rev.8, 6.3.4.3
@root
uid1 … 1F2.16.756.5.30.1.1.10.4.5
hl7:templateId
II1 … 1MIHE PalM TF3 Rev.8, 6.3.4.3
@root
uid1 … 1F1.3.6.1.4.1.19376.1.3.3.1.2.1
hl7:relatedSubject
1 … 1RIHE PalM TF3 Rev.8, 6.3.4.3
hl7:code
CE1 … 1The type of the non-human subject (animal species, food, material from nature, etc.) MUST be declared using a Code. LOINC (2.16.840.1.113883.6.1) or SNOMED CT (2.16.840.1.113883.6.96) codes or values from the HL7 Vocabulary ObservationType (2.16.840.1.113883.1.11.16226) SHOULD be used.
If no vocabulary is available, nullFlavor='OTH' including an originalText element MUST be used. In this case, the attributes @code, @codeSystem and @codeSystemName are NOT ALLOWED.
IHE PalM TF3 Rev.8, 6.3.4.3
@nullFlavor
cs0 … 1FASKU
 If no vocabulary is available, nullFlavor='ASKU' including a displayName MUST be used.
@code
cs0 … 1 The code MUST be specified.
@codeSystem
oid0 … 1 The OID of the code system MUST be specified.
@codeSystemName
st0 … 1 The name of the code system MUST be specified for tracking purposes. However, processing is NOT ALLOWED.
@displayName
st0 … 1 The displayName of the code MUST be specified for tracking purposes. However, processing is NOT ALLOWED. Instead, a processing system is to display a user readable language translation of the code from the value set.
Included0 … 1C from 2.16.756.5.30.1.1.10.9.49 Original Text Reference (DYNAMIC)
The human-readable text MUST be generated automatically from the structured information of this element. The text element MUST contain the reference to the corresponding text in the human readable part, ONLY.
hl7:originalText
ED0 … 1CCDA‑CH V2
hl7:reference
TEL1 … 1MThe reference to the corresponding text in the human readable part must be specified by reference to content[@ID]: reference[@value='#xxx']CDA‑CH V2
@value
1 … 1RReference to the narrative part of the section in the format '#xxx', where xxx is the ID of the corresponding element.
 Schematron assertrolered error 
 teststarts-with(@value,'#') 
 MessageThe @value attribute content MUST conform to the format '#xxx', where xxx is the ID of the corresponding 'content' element. 
 Variable letNameidvalue 
 Valuesubstring-after(@value,'#') 
 Schematron assertrolered error 
 testancestor::hl7:structuredBody//*[@ID=$idvalue] 
 MessageNo narrative text found for this reference (no content element within this document has an ID that corresponds to '<value-of select="$idvalue"/>'). 
 Schematron assertrolered error 
 testparent::*/text()=ancestor::hl7:structuredBody//*[@ID=$idvalue]/text() 
 MessageThe originalText content MUST be identical to the narrative text for this reference. 
 Schematron assertrolered error 
 test(@code and @codeSystem) or (@nullFlavor='OTH' and hl7:originalText) 
 MessageEither a code with its code system or nullFlavor='OTH' with an originalText element is required. 
hl7:addr
AD1 … 1The address is where the material was located, from which the sample was taken. If it is not known, nullFavor='UNK' MUST be used.IHE PalM TF3 Rev.8, 6.3.4.3