Back To Index  <<  Back To Templates

ref Template  Non-Human Subject - subject Containment

Id 2.16.756.5.30.1.1.10.4.5
ref
ch-palm-
Effective Date 2017‑06‑21
Status pending Under pre-publication review Version Label 2017
Name chpalm_entry_NonHumanSubject Display Name Non-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.
Context Sibling nodes of template element with id 2.16.756.5.30.1.1.10.4.5
Label IHE PalM TF3 Rev.8, 6.3.4.3
Classification CDA Entry Level Template
Open/Closed Open (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 10 templates, Uses 1 template
Used by as Name Version
2.16.756.5.30.1.1.10.4.17 Containment pending Laboratory Isolate Organizer (2017) 2017‑06‑21
2.16.756.5.30.1.1.10.4.4 link pending Laboratory Report Data Processing Entry (2017) 2017‑06‑21
2.16.756.5.30.1.1.10.3.3 link pending Laboratory Speciality Section - coded (2017) 2017‑06‑21
2.16.756.5.30.1.1.10.1.17 link pending Immunization Recommendation Request (2018) 2018‑04‑19
2.16.756.5.30.1.1.10.1.18 link pending Immunization Recommendation Response (2018) 2018‑04‑19
2.16.756.5.30.1.1.10.1.19 link pending Vaccination Record (2018) 2018‑04‑19
2.16.756.5.30.1.1.10.3.5 link pending Laboratory Report Item Section - coded (2017) 2017‑06‑21
2.16.756.5.30.1.1.10.4.19 Containment pending Laboratory Battery Organizer (2017) 2017‑06‑21
2.16.756.5.30.1.1.10.4.3 Containment pending Laboratory Observation (2017) 2017‑06‑21
notice Circular reference found with 2.16.756.5.30.1.1.10.4.3, please check
2.16.756.5.30.1.1.10.4.11 link pending Specimen Collection (2017) 2017‑06‑21
Uses as Name Version
2.16.756.5.30.1.1.10.9.49 Include active Original Text Reference (2017) DYNAMIC
Relationship Specialization: template 2.16.840.1.113883.10.12.320 (2005‑09‑07)
Specialization: template 1.3.6.1.4.1.19376.1.3.3.1.2.1 (DYNAMIC)
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>
Item DT Card Conf Description Label
hl7:templateId
II 1 … 1 M IHE PalM TF3 Rev.8, 6.3.4.3
@root
uid 1 … 1 F 2.16.756.5.30.1.1.10.4.5
hl7:templateId
II 1 … 1 M IHE PalM TF3 Rev.8, 6.3.4.3
@root
uid 1 … 1 F 1.3.6.1.4.1.19376.1.3.3.1.2.1
hl7:relatedSubject
1 … 1 R IHE PalM TF3 Rev.8, 6.3.4.3
hl7:code
CE 1 … 1 The 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
cs 0 … 1 F ASKU
  If no vocabulary is available, nullFlavor='ASKU' including a displayName MUST be used.
@code
cs 0 … 1   The code MUST be specified.
@codeSystem
oid 0 … 1   The OID of the code system MUST be specified.
@codeSystemName
st 0 … 1   The name of the code system MUST be specified for tracking purposes. However, processing is NOT ALLOWED.
@displayName
st 0 … 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.
Included 0 … 1 C 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
ED 0 … 1 C CDA‑CH V2
hl7:reference
TEL 1 … 1 M The 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 … 1 R Reference to the narrative part of the section in the format '#xxx', where xxx is the ID of the corresponding element.
  Schematron assert role red error  
  test starts-with(@value,'#')  
  Message The @value attribute content MUST conform to the format '#xxx', where xxx is the ID of the corresponding <content/> element.  
  Variable let Name idvalue  
  Value substring-after(@value,'#')  
  Schematron assert role red error  
  test ancestor::hl7:structuredBody//*[@ID=$idvalue]  
  Message No narrative text found for this reference (no content element within this document has an ID that corresponds to '<value-of select="$idvalue"/>').  
  Schematron assert role red error  
  test parent::*/text()=ancestor::hl7:structuredBody//*[@ID=$idvalue]/text()  
  Message The originalText content MUST be identical to the narrative text for this reference.  
  Schematron assert role red error  
  test (@code and @codeSystem) or (@nullFlavor='OTH' and hl7:originalText)  
  Message Either a code with its code system or nullFlavor='OTH' with an originalText element is required.  
hl7:addr
AD 1 … 1 The 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