hl7:ClinicalDocument
|
|
|
|
|
(XeH rt2) |
hl7:realmCode
|
CS |
0 … 1 |
|
This element SHALL be present and is valued from the RealmOfUse [2.16.840.1.113883.1.11.11050]
subset, within the VocabularyDomainQualifier value set. In the international context
of this profile used as it is without any further extension, the realm code SHALL
be <realmCode code="UV"/> (universal).
Whenever a national extension has been defined and is used, the realm code SHALL identify
this national extension.
|
(XeH rt2) |
hl7:typeId
|
II |
1 … 1 |
R |
This element is a technology-neutral explicit reference to the standard CDA R2. It
SHALL be present and valued as follows:
ClinicalDocument/typeId@root = "2.16.840.1.113883.1.3" (which is the OID for HL7 Registered
models);
ClinicalDocument.typeId@extension = "POCD_HD000040" (which is the unique identifier
for the CDA, Release Two Hierarchical Description).
|
(XeH rt2) |
@hl7:schemaLocation
|
|
0 … 1 |
|
|
@extension
|
st |
1 … 1 |
R |
|
@root
|
uid |
1 … 1 |
R |
|
|
Example |
<hl7:typeId extension="extension" root="1.2.3.999"/> |
hl7:templateId
|
II |
1 … 1 |
R |
SHALL contain exactly one [1..1] templateId (CONF:1198-8404) such that it
|
(XeH rt2) |
@extension
|
st |
1 … 1 |
R |
|
@root
|
uid |
1 … 1 |
R |
|
hl7:id
|
II |
1 … 1 |
R |
SHALL contain exactly one [1..1] id (CONF:1198-30932).
|
(XeH rt2) |
@root
|
uid |
1 … 1 |
R |
|
hl7:code
|
CE.IPS |
1 … 1 |
R |
SHALL contain exactly one [1..1] code (CONF:1198-14833).
Preferred code is 18748-4 LOINC Diagnostic Imaging Report
|
(XeH rt2) |
hl7:title
|
ST |
1 … 1 |
R |
The Radiology Specialty Section <title> MAY be present. It is the local translation
of the code@displayName.
|
(XeH rt2) |
hl7:effectiveTime
|
TS.IPS.TZ |
1 … 1 |
R |
ClinicalDocument/effectiveTime SHALL be present. It contains the creation date & time
of the laboratory report as an electronic document. In case this is a new revision
replacing a previous version (identified in parentDocument), this is the date & time
of the new revision.
|
(XeH rt2) |
|
Example |
<hl7:effectiveTime value="20210804073321Z"/> |
hl7:confidentialityCode
|
CE.IPS (required) |
1 … 1 |
R |
ClinicalDocument/confidentialityCode SHALL be present in accordance with the HL7 CDA
R2 standard.
|
(XeH rt2) |
|
Example |
<hl7:confidentialityCode/> |
hl7:languageCode
|
CS |
0 … 1 |
R |
ClinicalDocument/languageCode SHALL be present in accordance with the HL7 CDA R2 standard.
|
(XeH rt2) |
hl7:setId
|
II |
1 … 1 |
R |
ClinicalDocument/setId SHALL be present to enable further updates of the clinical
document. It is an identifier that is common across all revisions of this laboratory
report.
|
(XeH rt2) |
hl7:versionNumber
|
INT |
0 … 1 |
|
ClinicalDocument/versionNumber MAY be present. As requested by the CDA standard, it
is an integer value used as versioning.
|
(XeH rt2) |
Included |
|
|
from 1.2.840.10008.9.1.10.2 DICOM recordTarget (DYNAMIC)
|
hl7:recordTarget
|
|
1 … * |
R |
|
(XeH rt2) |
hl7:templateId
|
II |
1 … 1 |
M |
|
(XeH rt2) |
@root
|
uid |
1 … 1 |
F |
1.2.840.10008.9.1.10.2 |
hl7:patientRole
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:id
|
II |
1 … * |
R |
|
(XeH rt2) |
@extension
|
st |
1 … 1 |
R |
|
@root
|
uid |
1 … 1 |
R |
|
hl7:addr
|
AD |
1 … * |
R |
|
(XeH rt2) |
hl7:telecom
|
TEL |
1 … * |
R |
|
(XeH rt2) |
hl7:patient
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:name
|
PN |
1 … 1 |
R |
|
(XeH rt2) |
hl7:administrativeGenderCode
|
CE (required) |
1 … 1 |
R |
|
(XeH rt2) |
hl7:birthTime
|
TS |
1 … 1 |
R |
|
(XeH rt2) |
hl7:providerOrganization
|
|
0 … 1 |
|
|
(XeH rt2) |
hl7:name
|
ON |
1 … * |
R |
|
(XeH rt2) |
hl7:telecom
|
TEL |
0 … * |
|
|
(XeH rt2) |
hl7:addr
|
AD |
0 … 1 |
|
|
(XeH rt2) |
Included |
1 … * |
R |
from 1.2.840.10008.9.1.10.4 DICOM author (DYNAMIC)
At least one ClinicalDocument/author SHALL be present with a time in accordance with
the HL7 CDA R2 standard and further constrained by this specification to require the
presence of name, addr and telecom. The author/time element carries the date&time
the laboratory report was produced. The laboratory report can be authored by a software
system or by a person or by both.
|
hl7:author
|
|
1 … * |
R |
|
(XeH rt2) |
hl7:time
|
TS |
1 … 1 |
R |
|
(XeH rt2) |
hl7:assignedAuthor
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:id
|
II |
1 … * |
R |
|
(XeH rt2) |
hl7:addr
|
AD |
1 … * |
R |
|
(XeH rt2) |
hl7:telecom
|
TEL |
1 … * |
R |
|
(XeH rt2) |
hl7:assignedPerson
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:name
|
PN |
1 … 1 |
R |
|
(XeH rt2) |
Included |
0 … 1 |
|
from 1.2.840.10008.9.1.10.11 DICOM dataEnterer (DYNAMIC)
|
hl7:dataEnterer
|
|
0 … 1 |
|
|
(XeH rt2) |
@typeCode
|
cs |
1 … 1 |
R |
|
hl7:assignedEntity
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:id
|
II |
0 … 1 |
|
|
(XeH rt2) |
hl7:assignedPerson
|
|
0 … 1 |
|
|
(XeH rt2) |
hl7:name
|
PN |
1 … 1 |
R |
|
(XeH rt2) |
Included |
1 … 1 |
R |
from 1.2.840.10008.9.1.10.6 DICOM custodian (DYNAMIC)
ClinicalDocument/custodian SHALL be present with an id in accordance with the HL7
CDA R2 standard and further constrained by this specification to require the presence
of name, addr and telecom. It represents the organization that is in charge of maintaining
the laboratory report.
|
hl7:custodian
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:assignedCustodian
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:representedCustodianOrganization
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:id
|
II |
1 … * |
R |
|
(XeH rt2) |
hl7:name
|
ON |
1 … 1 |
R |
|
(XeH rt2) |
hl7:addr
|
AD |
1 … 1 |
R |
|
(XeH rt2) |
hl7:telecom
|
TEL |
1 … 1 |
R |
|
(XeH rt2) |
Included |
|
|
from 1.2.840.10008.9.1.10.5 DICOM informationRecipient (DYNAMIC)
|
hl7:informationRecipient
|
|
0 … * |
|
|
(XeH rt2) |
hl7:intendedRecipient
|
|
1 … 1 |
R |
|
(XeH rt2) |
@classCode
|
cs |
1 … 1 |
R |
|
hl7:addr
|
AD |
0 … * |
|
|
(XeH rt2) |
hl7:telecom
|
TEL |
0 … * |
|
|
(XeH rt2) |
hl7:informationRecipient
|
|
0 … 1 |
|
|
(XeH rt2) |
hl7:name
|
PN |
1 … 1 |
R |
|
(XeH rt2) |
hl7:receivedOrganization
|
|
0 … 1 |
|
|
(XeH rt2) |
hl7:name
|
ON |
1 … 1 |
R |
|
(XeH rt2) |
Included |
0 … 1 |
|
from 1.2.840.10008.9.1.10.3 DICOM legalAutheticator (DYNAMIC)
The ClinicalDocument/legalAuthenticator MAY be present. When present, it SHALL be
in accordance with the HL7 CDA R2 standard and further constrained by this specification
to require the presence of name, addr and telecom. This element carries the person
who has legally authenticated the report, and the organization represented by this
person. The sub-element time carries the date&time this legal authentication took
place. The sub-element signatureCode carries the “signed” (S) status
If this entity happens also to be one of the validators of the laboratory results
in the report, it SHALL also be documented as a validator.
|
hl7:legalAuthenticator
|
|
0 … 1 |
|
|
(XeH rt2) |
hl7:time
|
TS |
1 … 1 |
R |
|
(XeH rt2) |
hl7:signatureCode
|
CS |
1 … 1 |
R |
|
(XeH rt2) |
hl7:assignedEntity
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:id
|
II |
1 … * |
R |
|
(XeH rt2) |
hl7:addr
|
AD |
1 … * |
R |
|
(XeH rt2) |
hl7:telecom
|
TEL |
1 … * |
R |
|
(XeH rt2) |
hl7:assignedPerson
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:name
|
PN |
1 … 1 |
R |
|
(XeH rt2) |
hl7:sdtc:signatureText
|
ED |
0 … 1 |
|
|
(XeH rt2) |
Included |
|
|
from 1.2.840.10008.9.1.10.8 DICOM inFullfilmentOf (DYNAMIC)
MAY contain zero or more [0..*] inFulfillmentOf (CONF:1198-30936).
An inFulfillmentOf element represents the Placer Order that is either a group of orders
(modeled as PlacerGroup in the Placer Order RMIM of the Orders & Observations domain)
or a single order item (modeled as ObservationRequest in the same RMIM). This optionality
reflects two major approaches to the grouping of procedures as implemented in the
installed base of imaging information systems. These approaches differ in their handling
of grouped procedures and how they are mapped to identifiers in the Digital Imaging
and Communications in Medicine (DICOM) image and structured reporting data. The example
of a CT examination covering chest, abdomen, and pelvis will be used in the discussion
below. In the IHE Scheduled Workflow model, the Chest CT, Abdomen CT, and Pelvis CT
each represent a Requested Procedure, and all three procedures are grouped under a
single Filler Order. The Filler Order number maps directly to the DICOM Accession
Number in the DICOM imaging and report data. A widely deployed alternative approach
maps the requested procedure identifiers directly to the DICOM Accession Number. The
Requested Procedure ID in such implementations may or may not be different from the
Accession Number, but is of little identifying importance because there is only one
Requested Procedure per Accession Number. There is no identifier that formally connects
the requested procedures ordered in this group.
|
hl7:inFullfilmentOf
|
|
1 … * |
R |
|
(XeH rt2) |
hl7:order
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:id
|
II |
1 … 1 |
R |
|
(XeH rt2) |
@extension
|
st |
1 … 1 |
R |
|
@root
|
uid |
1 … 1 |
R |
|
hl7:ps3-20:accessionNumber
|
II |
1 … 1 |
R |
|
(XeH rt2) |
@extension
|
st |
1 … 1 |
R |
|
@root
|
uid |
1 … 1 |
R |
|
hl7:code
|
CE |
0 … 1 |
|
|
(XeH rt2) |
hl7:priorityCode
|
CE |
0 … 1 |
|
|
(XeH rt2) |
Included |
|
|
from 1.2.840.10008.9.1.10.9 DICOM documentationOf (DYNAMIC)
HALL contain exactly one [1..1] documentationOf (CONF:1198-8416) such that it
Each serviceEvent indicates an imaging procedure that the provider describes and interprets
in the content of the DIR. The main activity being described by this document is the
interpretation of the imaging procedure. This is shown by setting the value of the
@classCode attribute of the serviceEvent element to ACT, and indicating the duration
over which care was provided in the effectiveTime element. Within each documentationOf
element, there is one serviceEvent element. This event is the unit imaging procedure
corresponding to a billable item. The type of imaging procedure may be further described
in the serviceEvent/code element. This guide makes no specific recommendations about
the vocabulary to use for describing this event. In IHE Scheduled Workflow environments,
one serviceEvent/id element contains the DICOM Study Instance UID from the Modality
Worklist, and the second serviceEvent/id element contains the DICOM Requested Procedure
ID from the Modality Worklist. These two ids are in a single serviceEvent. The effectiveTime
for the serviceEvent covers the duration of the imaging procedure being reported.
This event should have one or more performers, which may participate at the same or
different periods of time. Service events map to DICOM Requested Procedures. That
is, serviceEvent/id is the ID of the Requested Procedure.
|
hl7:documentationOf
|
|
1 … * |
R |
|
(XeH rt2) |
hl7:serviceEvent
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:id
|
II |
1 … 1 |
R |
|
(XeH rt2) |
hl7:code
|
CE |
1 … 1 |
R |
|
(XeH rt2) |
hl7:translation
|
CD |
1 … * |
R |
|
(XeH rt2) |
hl7:translation
|
CD |
0 … 1 |
|
|
(XeH rt2) |
hl7:effectiveTime
|
IVL_TS |
1 … 1 |
R |
|
(XeH rt2) |
hl7:low
|
TS |
1 … 1 |
R |
|
(XeH rt2) |
hl7:performer
|
|
0 … * |
|
|
(XeH rt2) |
@typeCode
|
cs |
1 … 1 |
R |
|
hl7:assignedEntity
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:id
|
II |
1 … 1 |
R |
|
(XeH rt2) |
hl7:assignedPerson
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:name
|
PN |
1 … 1 |
R |
|
(XeH rt2) |
Included |
0 … 1 |
|
from 1.2.840.10008.9.1.10.7 DICOM componentOf (DYNAMIC)
MAY contain zero or one [0..1] componentOf (CONF:1198-30939).
The id element of the encompassingEncounter represents the identifier for the encounter.
When the diagnostic imaging procedure is performed in the context of a hospital stay
or an outpatient visit for which there is an Encounter Number, that number should
be present as the ID of the encompassingEncounter. The effectiveTime represents the
time interval or point in time in which the encounter took place. The encompassing
encounter might be that of the hospital or office visit in which the diagnostic imaging
procedure was performed. If the effective time is unknown, a nullFlavor attribute
can be used.
|
hl7:componentOf
|
|
0 … 1 |
R |
|
(XeH rt2) |
hl7:encompassingEncounter
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:id
|
II |
0 … 1 |
|
|
(XeH rt2) |
@extension
|
st |
1 … 1 |
R |
|
@root
|
uid |
1 … 1 |
R |
|
hl7:effectiveTime
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:location
|
|
0 … 1 |
|
|
(XeH rt2) |
hl7:healthCareFacility
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:location
|
|
0 … 1 |
|
|
(XeH rt2) |
hl7:name
|
EN |
1 … 1 |
R |
|
(XeH rt2) |
hl7:addr
|
AD |
1 … 1 |
R |
|
(XeH rt2) |
hl7:serviceProviderOrganization
|
|
0 … 1 |
|
|
(XeH rt2) |
hl7:name
|
ON |
1 … 1 |
R |
|
(XeH rt2) |
hl7:encounterParticipant
|
|
0 … * |
|
|
(XeH rt2) |
@typeCode
|
|
1 … 1 |
R |
|
hl7:assignedEntity
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:assignedPerson
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:name
|
EN |
1 … 1 |
R |
|
(XeH rt2) |
Included |
1 … 1 |
R |
from 1.2.840.10008.9.1.10.10 DICOM participant (DYNAMIC)
|
hl7:participant
|
|
1 … 1 |
R |
|
(XeH rt2) |
@typeCode
|
cs |
1 … 1 |
R |
|
hl7:associatedEntity
|
|
1 … 1 |
R |
|
(XeH rt2) |
@classCode
|
cs |
1 … 1 |
R |
|
hl7:id
|
II |
0 … 1 |
|
|
(XeH rt2) |
hl7:addr
|
AD |
0 … * |
|
|
(XeH rt2) |
hl7:telecom
|
TEL |
0 … * |
|
|
(XeH rt2) |
hl7:associatedPerson
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:name
|
PN |
1 … 1 |
R |
|
(XeH rt2) |
hl7:component
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:structuredBody
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:component
|
|
0 … 1 |
|
|
(XeH rt2) |
hl7:section
|
|
|
|
Contains 1.2.840.10008.9.2 Clinical Information (DYNAMIC)
|
(XeH rt2) |
hl7:component
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:section
|
|
|
|
Contains 1.2.840.10008.9.3 Imaging Procedure Description (DYNAMIC)
|
(XeH rt2) |
hl7:component
|
|
0 … 1 |
|
|
(XeH rt2) |
hl7:section
|
|
|
|
Contains 1.2.840.10008.9.4 Comparison Study (DYNAMIC)
|
(XeH rt2) |
hl7:component
|
|
0 … 1 |
|
|
(XeH rt2) |
hl7:section
|
|
|
|
Contains 2.16.840.1.113883.10.20.6.1.2 Findings (DYNAMIC)
|
(XeH rt2) |
hl7:component
|
|
1 … 1 |
R |
|
(XeH rt2) |
hl7:section
|
|
|
|
Contains 1.2.840.10008.9.5 Impression (DYNAMIC)
|
(XeH rt2) |
hl7:component
|
|
0 … * |
|
|
(XeH rt2) |
hl7:section
|
|
|
|
Contains 1.2.840.10008.9.6 Addendum (DYNAMIC)
|
(XeH rt2) |