Template

Show index

Template XeH Laboratory Battery Organizer 2022‑05‑09 22:33:51

Id2.16.840.1.113883.2.51.10.70Effective Date2022‑05‑09 22:33:51
Statusactive ActiveVersion Label2017
NameXeHLaboratoryBatteryOrganizerDisplay NameXeH Laboratory Battery Organizer
Description
A Laboratory Battery Organizer is used to group Laboratory Observations (1.3.6.1.4.1.19376.1.3.1.6) for a battery of tests. Laboratory Battery Organizer, when present, SHALL be recorded as an organizer under the Laboratory Data Processing Entry as demonstrated.
ContextParent nodes of template element with id 2.16.840.1.113883.2.51.10.70
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 2 templates, Uses 11 templates
Used by as NameVersion
2.16.840.1.113883.2.51.10.36Containmentactive XeH Laboratory Report Data Processing Entry (1.0)2021‑10‑07 00:14:07
2.16.840.1.113883.2.51.10.92Containmentactive XeH Laboratory Isolate Organizer (1.0)2022‑07‑31 07:54:30
Uses as NameVersion
1.3.6.1.4.1.19376.1.3.3.1.2.1Containmentactive Non-Human Subject (2017)DYNAMIC
1.3.6.1.4.1.19376.1.3.3.1.3.1Containmentactive Human Patient with Non-Human Subject (2017)DYNAMIC
1.3.6.1.4.1.19376.1.3.3.1.7Containmentactive Laboratory Performer (2017)DYNAMIC
1.3.6.1.4.1.19376.1.3.10.9.2Containmentactive Multimedia Embedded Content (2017)DYNAMIC
1.3.6.1.4.1.19376.1.3.10.9.17Containmentactive Author with Name, Addr, Telecom (2017)DYNAMIC
1.3.6.1.4.1.19376.1.5.3.1.4.2Containmentactive IHE Comment Entry (2014)DYNAMIC
2.16.840.1.113883.2.51.10.18Containmentactive XeH Internal Reference (1.0)DYNAMIC
2.16.840.1.113883.2.51.10.42Containmentactive XeH Specimen Collection (2021)DYNAMIC
2.16.840.1.113883.2.51.10.56Containmentactive XeH Laboratory Observation (1.0)DYNAMIC
2.16.840.1.113883.2.51.10.74Includeactive XeH Lab Results Validator Participant (1.0)DYNAMIC
2.16.840.1.113883.2.51.10.91Includeactive XeH Lab Device Participant (1.0)DYNAMIC
RelationshipAdaptation: template 1.3.6.1.4.1.19376.1.3.1.4 Laboratory Battery Organizer (2008‑08‑08)
ref
XDLAB-

Adaptation: template 2.16.840.1.113883.10.12.305 CDA Organizer (2005‑09‑07)
ref
ad1bbr-
Example
Laboratory Battery Organizer Example
<organizer classCode="BATTERY" moodCode="EVN">
  <templateId root="1.3.6.1.4.1.19376.1.3.1.4"/>  <id root=" " extension=" "/>  <code code="29576-6" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC" displayName="Microbiology Susceptibility">
    <originalText>
      <reference value="susceptibilityTest"/>    </originalText>  </code>  <statusCode code="completed"/>  <effectiveTime value="20071108000000.0000-0500"/>  <specimen typeCode="SPC">
    <specimenRole classCode="ISLT">
      <!-- ... -->
    </specimenRole>  </specimen>  <performer typeCode="PRF">
    <templateId root="1.3.6.1.4.1.19376.1.3.3.1.7"/>    <!-- ... -->
  </performer>  <author typeCode="AUT">
    <templateId root=" "/>    <!-- ... -->
  </author>  <participant typeCode="AUTHEN">
    <templateId root="1.3.6.1.4.1.19376.1.3.3.1.5"/>    <!-- ... -->
  </participant>  <participant typeCode="RESP">
    <!-- ... -->
  </participant>  <participant typeCode="DEV">
    <!-- ... -->
  </participant>  <component>
    <observation classCode="OBS" moodCode="EVN">
      <templateId root="1.3.6.1.4.1.19376.1.3.1.6"/>      <!-- ... -->
    </observation>  </component>  <component>
    <observation classCode="OBS" moodCode="EVN">
      <templateId root="1.3.6.1.4.1.19376.1.3.1.6"/>      <!-- ... -->
    </observation>  </component>  <component>
    <act classCode="ACT" moodCode="EVN">
      <templateId extension="1.3.6.1.4.1.19376.1.5.3.1.4.2"/>      <code code="48767-8" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC" displayName="Annotation Comment"/>      <text>
        <reference value="organizerComment"/>      </text>      <statusCode code="completed"/>    </act>  </component></organizer>
ItemDTCardConfDescriptionLabel
hl7:organizer
XeHLdotsizer
@classCode
cs1 … 1FBATTERY
@moodCode
cs1 … 1FEVN
hl7:templateId
II1 … 1MXeHLdotsizer
@root
uid1 … 1F2.16.840.1.113883.2.51.10.70
hl7:id
II0 … 1RIf present, represents the lab filler order number (ORC-3 and OBR-3 in HL7 v2.5) for this batteryXeHLdotsizer
hl7:code
CD (preferred)0 … 1RUnique code for the battery in the appropriate vocabulary (e.g. SNOMED CT)XeHLdotsizer
 ConstraintThe code SHALL be selected out of values in the value-set, which are on level "1-L" or higher (not "0-L" values!)
The code SHALL NOT conflict with the Laboratory Study Type Code present at parent "Laboratory Specialty" section.
 CONF
The value of @code comes preferably from value set 2.16.840.1.113883.2.51.13.1.2 XeH Lab Study Types (DYNAMIC)
hl7:statusCode
CS1 … 1M‘completed’ when all expected results for this battery are in a final state.
‘aborted’ if the battery did not reach the end of testing. Some results MAY be there.		XeHLdotsizer
 CONF
@code shall be "completed"
or
@code shall be "aborted"
hl7:effectiveTime
IVL_TS0 … 1RTime of results on this batteryXeHLdotsizer
Choice0 … 1Elements to choose from:
hl7:subject
0 … 1subject in case of a non-human subject attached to the isolate
Contains 1.3.6.1.4.1.19376.1.3.3.1.2.1 Non-Human Subject (DYNAMIC)		XeHLdotsizer
@typeCode
cs0 … 1FSBJ
hl7:subject
0 … 1subject in case of a non-human subject attached to the isolate
Contains 1.3.6.1.4.1.19376.1.3.3.1.3.1 Human Patient with Non-Human Subject (DYNAMIC)		XeHLdotsizer
@typeCode
cs0 … 1FSBJ
hl7:performer
0 … *performer participation. Performer to supersede those recorded at higher level.
Contains 1.3.6.1.4.1.19376.1.3.3.1.7 Laboratory Performer (DYNAMIC)		XeHLdotsizer
hl7:author
0 … *author participation used to supersede the authors of higher level.
Contains 1.3.6.1.4.1.19376.1.3.10.9.17 Author with Name, Addr, Telecom (DYNAMIC)		XeHLdotsizer
hl7:participant
0 … 1AUTHEN: The verifier of the battery organizer. In the case where a laboratory report has multiple verifiers. Each verifier is attached to the subset of batteries/observations he or she verified, by the means of a <participant> element.

Note: See "other participants" ("AUTHEN", "RESP", "DEV") according to IHE XD-LAB profile
XeHLdotsizer
where [@typeCode='AUTHEN']
@typeCode
cs1 … 1FAUTHEN
Included1 … 1M from 2.16.840.1.113883.2.51.10.74 XeH Lab Results Validator Participant (DYNAMIC)
hl7:time
TS1 … 1MXeHLdotspant
hl7:participantRole
1 … 1MXeHLdotspant
@classCode
cs0 … 1FROL
hl7:id
II1 … *RXeHLdotspant
hl7:code
CE.IPS (preferred)0 … 1A code, which identifies the profession/competence/specialty of the author when it is a person.
XeHLdotspant
 CONF
The value of @code comes preferably from value set 2.16.840.1.113883.11.22.53 IPS Healthcare Professional Roles (DYNAMIC)
hl7:addr
AD0 … *XeHLdotspant
hl7:telecom
TEL0 … *XeHLdotspant
hl7:playingEntity
0 … 1RXeHLdotspant
hl7:name
PN1 … 1RXeHLdotspant
hl7:participant
0 … 1RESP: The person responsible for the provision of the battery. In the case where this battery is subcontracted to an external laboratory, this external laboratory (with its address and telcom) and the actual performer is represented by a <performer> element, whereas the Director of this subcontractor laboratory is carried by the <participant> element being attached to the same level as the <performer> element.

Note: See "other participants" ("AUTHEN", "RESP", "DEV") according to IHE XD-LAB profile
XeHLdotsizer
where [@typeCode='RESP']
@typeCode
cs1 … 1FRESP
hl7:participant
0 … 1DEV: A device or equipment, which was used to produce this battery of results (e.g. an analyzer).

Note: See "other participants" ("AUTHEN", "RESP", "DEV") according to IHE XD-LAB profile
XeHLdotsizer
where [@typeCode='DEV']
@typeCode
cs1 … 1FDEV
Included1 … 1M from 2.16.840.1.113883.2.51.10.91 XeH Lab Device Participant (DYNAMIC)
hl7:participantRole
1 … 1MXeHLdotspant
hl7:id
II0 … *The UDI Device Identifier MAY be specified as a second id element.
XeHLdotspant
hl7:playingDevice
1 … 1MXeHLdotspant
hl7:code
CE.IPS0 … 1Coded product type
XeHLdotspant
hl7:manufacturerModelName
SC0 … 1The element manufacturerModelName“ is intended to be used in the same manner as element “modelNumber” specified in the FHIR device resource. It shall carry model information of the device or software provided in element softwareName
XeHLdotspant
hl7:softwareName
SC1 … 1M
The element softwareName is the primary element and intended to be used in the same manner as element “deviceName” specified in the FHIR device resource. It should carry the name of the device or software.

Is SHOULD including the manufacturer name.

Note: In case of usage for laboratory related documentation (e.g. Laboratory Result Report), the device structure is also used to record "Laboratory Kits" used for the examination.
XeHLdotspant
hl7:component
0 … *RContains 2.16.840.1.113883.2.51.10.42 XeH Specimen Collection (DYNAMIC)XeHLdotsizer
@typeCode
cs0 … 1FCOMP
hl7:component
0 … *RContains 2.16.840.1.113883.2.51.10.56 XeH Laboratory Observation (DYNAMIC)XeHLdotsizer
@typeCode
cs0 … 1FCOMP
hl7:component
0 … *RContains 1.3.6.1.4.1.19376.1.3.10.9.2 Multimedia Embedded Content (DYNAMIC)XeHLdotsizer
@typeCode
cs0 … 1FCOMP
hl7:component
0 … *RContains 1.3.6.1.4.1.19376.1.5.3.1.4.2 IHE Comment Entry (DYNAMIC)XeHLdotsizer
@typeCode
cs0 … 1FCOMP
hl7:component
0 … *RInternal reference to an "Order Id" provided in the header of the document (inFullfilmentOf/order/id).

Inherits to elements within the battery.

Note: Usually used in case of multiple orders present 

Contains 2.16.840.1.113883.2.51.10.18 XeH Internal Reference (DYNAMIC)		XeHLdotsizer
@typeCode
cs0 … 1FCOMP
hl7:component
0 … *RInternal reference to an "Ordering provider" provided in the header of the document (participant[@typeCode='REF']/associatedEntity/id).

Inherits to elements within the battery.

Note: Usually used in case of multiple orders present

Contains 2.16.840.1.113883.2.51.10.18 XeH Internal Reference (DYNAMIC)		XeHLdotsizer
@typeCode
cs0 … 1FCOMP