| Name | Flags | Card. | Type |
Description & Constraints
|
|---|---|---|---|---|
ClinicalDocument
|
USRealmHeader | |||
Slices for templateId
|
Slice: Unordered, Open by value:root, value:extension | |||
templateId:secondary
|
C | 1..1 | 1198-32937: When asserting this templateId, all C-CDA 2.1 section and entry templates that had a previous version in C-CDA R1.1 **SHALL** include both the C-CDA 2.1 templateId and the C-CDA R1.1 templateId root without an extension. See C-CDA R2.1 Volume 1 - Design Considerations for additional detail (CONF:1198-32937). | |
root
|
1..1 | Required Pattern: 2.16.840.1.113883.10.20.22.1.5 | ||
extension
|
1..1 | Required Pattern: 2014-06-09 | ||
|
id
|
1..1 | |||
root
|
C | 1..1 |
1198-30934:
The ClinicalDocument/id/@root attribute SHALL be a syntactically correct OID, and SHALL NOT be a UUID (CONF:1198-30934).
OIDs SHALL be represented in dotted decimal notation, where each decimal number is either 0 or starts with a nonzero digit. More formally, an OID SHALL be in the form of the regular expression: ([0-2])(.([1-9][0-9]*|0))+ 1198-30935: OIDs SHALL be no more than 64 characters in length (CONF:1198-30935). |
|
|
code
|
1..1 | Preferred code is 18748-4 LOINC Diagnostic Imaging Report | ||
|
code
|
1..1 | Binding: todo ( preferred ) | ||
|
informant
|
0 .. 0 | |||
|
informationRecipient
|
C | 0..* |
1198-8412:
The physician requesting the imaging procedure (ClinicalDocument/participant[@typeCode=REF]/associatedEntity), if present, **SHOULD** also be recorded as an informationRecipient, unless in the local setting another physician (such as the attending physician for an inpatient) is known to be the appropriate recipient of the report (CONF:1198-8412). 1198-8413: When no referring physician is present, as in the case of self-referred screening examinations allowed by law, the intendedRecipient **MAY** be absent. The intendedRecipient **MAY** also be the health chart of the patient, in which case the receivedOrganization **SHALL** be the scoping organization of that chart (CONF:1198-8413). |
|
|
Slices for participant
|
If participant is present, the associatedEntity/associatedPerson element SHALL be present and SHALL represent the physician requesting the imaging procedure (the referring physician AssociatedEntity that is the target of ClincalDocument/participant@typeCode=REF).
Slice: Unordered, Open by value:ClinicalDocument.associatedEntity |
|||
|
participant:participant1
|
0..1 | |||
|
associatedEntity
|
1..1 | |||
|
associatedPerson
|
1..1 | |||
name
|
1..1 | http://hl7.org/fhir/cda/StructureDefinition/PN | ||
|
inFulfillmentOf
|
0..* |
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. |
||
|
order
|
1..1 | |||
|
id
|
1..* |
DICOM Accession Number in the DICOM imaging and report data |
||
|
Slices for documentationOf
|
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.
Slice: Unordered, Open by value:ClinicalDocument.serviceEvent |
|||
|
documentationOf:documentationOf1
|
1..1 | |||
|
serviceEvent
|
1..1 | |||
|
classCode
|
1..1 | Required Pattern: ACT | ||
|
id
|
0..* | |||
|
code
|
C | 1..1 | 1198-8420: The value of serviceEvent/code **SHALL NOT** conflict with the ClininicalDocument/code. When transforming from DICOM SR documents that do not contain a procedure code, an appropriate nullFlavor **SHALL** be used on serviceEvent/code (CONF:1198-8420). | |
|
performer
|
0..* | http://hl7.org/fhir/cda/StructureDefinition/Performer1 |
The performer is the Physician Reading Study Performer defined in serviceEvent and is usually different from the attending physician. The reading physician interprets the images and evidence of the study (DICOM Definition). |
|
|
relatedDocument
|
C | 0..1 |
A DIR may have three types of parent document: ? A superseded version that the present document wholly replaces (typeCode = RPLC). DIRs may go through stages of revision prior to being legally authenticated. Such early stages may be drafts from transcription, those created by residents, or other preliminary versions. Policies not covered by this specification may govern requirements for retention of such earlier versions. Except for forensic purposes, the latest version in a chain of revisions represents the complete and current report. ? An original version that the present document appends (typeCode = APND). When a DIR is legally authenticated, it can be amended by a separate addendum document that references the original. ? A source document from which the present document is transformed (typeCode = XFRM). A DIR may be created by transformation from a DICOM Structured Report (SR) document or from another DIR. An example of the latter case is the creation of a derived document for inclusion of imaging results in a clinical document. 1198-8433: When a Diagnostic Imaging Report has been transformed from a DICOM SR document, relatedDocument/@typeCode **SHALL** be XFRM, and relatedDocument/parentDocument/id **SHALL** contain the SOP Instance UID of the original DICOM SR document (CONF:1198-8433). |
|
|
parentDocument
|
1..1 | |||
|
id
|
C | 1..1 |
1198-10031:
OIDs **SHALL** be represented in dotted decimal notation, where each decimal number is either 0 or starts with a nonzero digit. More formally, an OID **SHALL** be in the form of the regular expression: ([0-2])(.([1-9][0-9][*]|0))+ (CONF:1198-10031). 1198-10032: OIDs **SHALL** be no more than 64 characters in length (CONF:1198-10032). |
|
|
componentOf
|
0..1 | 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. | ||
|
encompassingEncounter
|
1..1 | 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. | ||
|
id
|
C | 1..* |
1198-30942:
In the case of transformed DICOM SR documents, an appropriate null flavor **MAY** be used if the id is unavailable (CONF:1198-30942). |
|
|
effectiveTime
|
1..1 | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS | ||
|
responsibleParty
|
0..1 | |||
|
assignedEntity
|
C | 1..1 | 1198-30947: **SHOULD** contain zero or one [0..1] assignedPerson *OR* contain zero or one [0..1] representedOrganization (CONF:1198-30947). | |
|
encounterParticipant
|
0..1 | http://hl7.org/fhir/cda/StructureDefinition/EncounterParticipant | ||
|
component
|
1..1 | |||
|
structuredBody
|
1..1 | |||
|
Slices for component
|
Slice: Unordered, Open by value:ClinicalDocument.section | |||
component:component1
|
1..1 | |||
section
|
1..1 | http://hl7.org/fhir/cda/StructureDefinition/Section | ||
|
component:component2
|
0..1 | |||
|
section
|
C | 1..1 | http://hl7.org/fhir/cda/StructureDefinition/Section | 1198-31206: The DICOM Object Catalog section (templateId 2.16.840.1.113883.10.20.6.1.1), if present, **SHALL** be the first section in the document Body (CONF:1198-31206). |
|
component:component3
|
0..* | |||
|
section
|
C | 1..1 |
1198-31211:
All sections defined in the DIR Section Type Codes table **SHALL** be top-level sections (CONF:1198-31211). 1198-31212: **SHALL** contain at least one text element or one or more component elements (CONF:1198-31212). |
|
|
code
|
1..1 | |||
|
code
|
1..1 |
The section/code SHOULD be selected from LOINC or DICOM for sections not listed in the DIR Section Type Codes table
undefined Binding: todo ( preferred ) |
||
|
title
|
0..1 | There is no equivalent to section/title in DICOM SR, so for a CDA to SR transformation, the section/code will be transferred and the title element will be dropped. | ||
|
text
|
C | 0..1 |
1198-31060:
If clinical statements are present, the section/text **SHALL** represent faithfully all such statements and **MAY** contain additional text (CONF:1198-31060). 1198-31061: All text elements **SHALL** contain content. Text elements **SHALL** contain PCDATA or child elements (CONF:1198-31061). 1198-31062: The text elements (and their children) **MAY** contain Web Access to DICOM Persistent Object (WADO) references to DICOM objects by including a linkHtml element where @href is a valid WADO URL and the text content of linkHtml is the visible text of the hyperlink (CONF:1198-31062). |
|
|
subject
|
0..* | |||
|
relatedSubject
|
1..1 | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject | ||
|
Slices for author
|
This author element is used when the author of a section is different from the author(s) listed in the Header
Slice: Unordered, Open by value:assignedAuthor |
|||
|
author:author1
|
0..* | |||
|
assignedAuthor
|
1..1 | http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor | ||
|
Slices for entry
|
Slice: Unordered, Open by value:ClinicalDocument.section.structuredBody.component.section.entry | |||
|
entry
|
0..* |
If the service context of a section is different from the value specified in documentationOf/serviceEvent, then the section SHALL contain one or more entries containing Procedure Context (templateId 2.16.840.1.113883.10.20.6.2.5), which will reset the context for any clinical statements nested within those elements |
||
|
act
|
1..1 | http://hl7.org/fhir/cda/StructureDefinition/Act | ||
|
entry:textObs
|
0..* | |||
|
observation
|
1..1 | http://hl7.org/fhir/cda/StructureDefinition/Observation | ||
|
entry:entry3
|
0..* | |||
|
observation
|
1..1 | http://hl7.org/fhir/cda/StructureDefinition/Observation | ||
|
entry:entry4
|
0..* | |||
|
observation
|
1..1 | http://hl7.org/fhir/cda/StructureDefinition/Observation | ||
|
entry:entry5
|
0..* | |||
|
observation
|
1..1 | http://hl7.org/fhir/cda/StructureDefinition/Observation | ||
|
component
|
C | 0..* |
1198-31210:
**SHALL** contain child elements (CONF:1198-31210). |
|
|
Documentation for this format
|
||||