International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions
Logical Model:
IPS Radiology Result Observation Component
Official URL : http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.17--20240804201847
Version :
1.1.0-ballot
Draft
as of 2024-08-04
Computable Name : IPSRadiologyResultObservationComponent
Other Identifiers: OID:2.16.840.1.113883.10.22.17 (use: official, )
IPS Radiology Result Observation Component
The component carries additional detailed radiological results. Depending on it’s type the code and value have different constraints to reflect proper results.
|
Type of result
|
Constraints for code (Value Set)
|
Value Domain value type
|
|
Observation Text
|
IPS Results Radiology Textual Observations
|
String
|
|
Observation Code
|
IPS Results Radiology Observation
|
Code
|
|
Observation Measurement, including linear, area and volume quantity measurements
|
IPS Results Radiology Measurement Observation
|
Quantity
|
|
Observation Measurement, including linear, area and volume range measurements
|
IPS Results Radiology Measurement Observation
|
Interval of quantity
|
|
Observation Measurement, including linear, area and volume ratio measurements
|
IPS Results Radiology Measurement Observation
|
Ratio of quantity
|
|
Observation Measurement, including linear, area and volume sampled data measurements
|
IPS Results Radiology Measurement Observation
|
Sample Data (Binary)
|
Usage:
Formal Views of Template Content
Description of Template, Differentials, Snapshots and how the different presentations work .
This structure is derived from Observation
Name Flags Card. Type Description & Constraints Observation 0..*
Observation XML Namespace: urn:hl7-org:v3@nullFlavor , realmCode , typeId , templateId , @classCode , @moodCode , @negationInd , id , code , derivationExpr , text , statusCode , effectiveTime , priorityCode , repeatNumber , languageCode , value , interpretationCode , methodCode , targetSiteCode , subject , specimen , performer , author , informant , participant , entryRelationship , reference , precondition , sdtcPrecondition2 , referenceRange , sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) templateId S 1..1
II @root 1..1
string Fixed Value: 2.16.840.1.113883.10.12.303 @classCode 1..1
code Fixed Value: OBS @moodCode 1..1
code Binding: urn:oid:2.16.840.1.113883.1.11.18943 (required ): x_ActMoodDocumentObservationid 0..*
II text 0..1
ED statusCode 0..1
CS Binding: ActStatus (required ): ActStatuseffectiveTime 0..1
IVL_TS
Terminology Bindings (Differential)
Path Conformance ValueSet URI Observation.moodCode required urn:oid:2.16.840.1.113883.1.11.18943
urn:oid:2.16.840.1.113883.1.11.18943
Observation.statusCode required ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
Name Flags Card. Type Description & Constraints Observation 0..*
Observation XML Namespace: urn:hl7-org:v3@nullFlavor , realmCode , typeId , templateId , @classCode , @moodCode , @negationInd , id , code , derivationExpr , text , statusCode , effectiveTime , priorityCode , repeatNumber , languageCode , value , interpretationCode , methodCode , targetSiteCode , subject , specimen , performer , author , informant , participant , entryRelationship , reference , precondition , sdtcPrecondition2 , referenceRange , sdtcInFulfillmentOf1 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) templateId S 1..1
II @root 1..1
string Fixed Value: 2.16.840.1.113883.10.12.303 @classCode 1..1
code Binding: CDAActClassObservation (required )Fixed Value: OBS @moodCode 1..1
code Binding: urn:oid:2.16.840.1.113883.1.11.18943 (required ): x_ActMoodDocumentObservationid 0..*
II code 1..1
CD Binding: ObservationType (example )text 0..1
ED statusCode 0..1
CS Binding: ActStatus (required ): ActStatuseffectiveTime 0..1
IVL_TS
Terminology Bindings
Path Conformance ValueSet / Code URI Observation.classCode required Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCode required urn:oid:2.16.840.1.113883.1.11.18943
urn:oid:2.16.840.1.113883.1.11.18943
Observation.code example ObservationType http://terminology.hl7.org/ValueSet/v3-ObservationType
Observation.statusCode required ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
Name Flags Card. Type Description & Constraints Observation 0..*
Observation XML Namespace: urn:hl7-org:v3@nullFlavor , realmCode , typeId , templateId , @classCode , @moodCode , @negationInd , id , code , derivationExpr , text , statusCode , effectiveTime , priorityCode , repeatNumber , languageCode , value , interpretationCode , methodCode , targetSiteCode , subject , specimen , performer , author , informant , participant , entryRelationship , reference , precondition , sdtcPrecondition2 , referenceRange , sdtcInFulfillmentOf1 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) @nullFlavor 0..1
cs Binding: CDANullFlavor (required )realmCode 0..*
CS typeId 0..1
II @nullFlavor 0..1
cs Binding: CDANullFlavor (required )@assigningAuthorityName 0..1
st @displayable 0..1
bl @root 1..1
oid , uuid , ruid Fixed Value: 2.16.840.1.113883.1.3 @extension 1..1
st templateId S 1..1
II @nullFlavor 0..1
cs Binding: CDANullFlavor (required )@assigningAuthorityName 0..1
st @displayable 0..1
bl @root 1..1
string Fixed Value: 2.16.840.1.113883.10.12.303 @extension 0..1
st @classCode 1..1
code Binding: CDAActClassObservation (required )Fixed Value: OBS @moodCode 1..1
code Binding: urn:oid:2.16.840.1.113883.1.11.18943 (required ): x_ActMoodDocumentObservation@negationInd 0..1
bl id 0..*
II code 1..1
CD Binding: ObservationType (example )derivationExpr 0..1
ST text 0..1
ED statusCode 0..1
CS Binding: ActStatus (required ): ActStatuseffectiveTime 0..1
IVL_TS priorityCode 0..1
CE Binding: ActPriority (example )repeatNumber 0..1
IVL_INT languageCode 0..1
CS Binding: AllLanguages (required )value 0..*
value ANY value BL value ED value ST value CD value CV value CE value CO value SC value II value TEL value AD value EN value INT value REAL value PQ value MO value TS value IVL_PQ value IVL_TS value PIVL_TS value EIVL_TS value SXPR_TS value RTO_PQ_PQ interpretationCode 0..*
CE Binding: CDAObservationInterpretation (required )methodCode 0..*
CE Binding: ObservationMethod (example )targetSiteCode 0..*
CD subject 0..1
Subject specimen 0..*
Specimen performer 0..*
Performer2 author 0..*
Author informant 0..*
Informant participant 0..*
Participant2 entryRelationship 0..*
EntryRelationship reference 0..*
Reference precondition 0..*
Precondition sdtcPrecondition2 0..*
Precondition2 XML Namespace: urn:hl7-org:sdtcXML: precondition2 (urn:hl7-org:sdtc)referenceRange 0..*
InfrastructureRoot @nullFlavor 0..1
cs Binding: CDANullFlavor (required )realmCode 0..*
CS typeId 0..1
II @nullFlavor 0..1
cs Binding: CDANullFlavor (required )@assigningAuthorityName 0..1
st @displayable 0..1
bl @root 1..1
oid , uuid , ruid Fixed Value: 2.16.840.1.113883.1.3 @extension 1..1
st templateId 0..*
II @typeCode 0..1
cs Binding: CDAActRelationshipType (required )Fixed Value: REFV observationRange 1..1
ObservationRange sdtcInFulfillmentOf1 0..*
InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtcXML: inFulfillmentOf1 (urn:hl7-org:sdtc)
Terminology Bindings
Path Conformance ValueSet / Code URI Observation.nullFlavor required CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.typeId.nullFlavor required CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.templateId.nullFlavor required CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.classCode required Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCode required urn:oid:2.16.840.1.113883.1.11.18943
urn:oid:2.16.840.1.113883.1.11.18943
Observation.code example ObservationType http://terminology.hl7.org/ValueSet/v3-ObservationType
Observation.statusCode required ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.priorityCode example ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Observation.languageCode required AllLanguages http://hl7.org/fhir/ValueSet/all-languages
Observation.interpretationCode required CDAObservationInterpretation http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
Observation.methodCode example ObservationMethod http://terminology.hl7.org/ValueSet/v3-ObservationMethod
Observation.referenceRange.nullFlavor required CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeId.nullFlavor required CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeCode required Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType
This structure is derived from Observation
Summary
Mandatory: 4 elements
Differential View
This structure is derived from Observation
Name Flags Card. Type Description & Constraints Observation 0..*
Observation XML Namespace: urn:hl7-org:v3@nullFlavor , realmCode , typeId , templateId , @classCode , @moodCode , @negationInd , id , code , derivationExpr , text , statusCode , effectiveTime , priorityCode , repeatNumber , languageCode , value , interpretationCode , methodCode , targetSiteCode , subject , specimen , performer , author , informant , participant , entryRelationship , reference , precondition , sdtcPrecondition2 , referenceRange , sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) templateId S 1..1
II @root 1..1
string Fixed Value: 2.16.840.1.113883.10.12.303 @classCode 1..1
code Fixed Value: OBS @moodCode 1..1
code Binding: urn:oid:2.16.840.1.113883.1.11.18943 (required ): x_ActMoodDocumentObservationid 0..*
II text 0..1
ED statusCode 0..1
CS Binding: ActStatus (required ): ActStatuseffectiveTime 0..1
IVL_TS
Terminology Bindings (Differential)
Path Conformance ValueSet URI Observation.moodCode required urn:oid:2.16.840.1.113883.1.11.18943
urn:oid:2.16.840.1.113883.1.11.18943
Observation.statusCode required ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
Key Elements View
Name Flags Card. Type Description & Constraints Observation 0..*
Observation XML Namespace: urn:hl7-org:v3@nullFlavor , realmCode , typeId , templateId , @classCode , @moodCode , @negationInd , id , code , derivationExpr , text , statusCode , effectiveTime , priorityCode , repeatNumber , languageCode , value , interpretationCode , methodCode , targetSiteCode , subject , specimen , performer , author , informant , participant , entryRelationship , reference , precondition , sdtcPrecondition2 , referenceRange , sdtcInFulfillmentOf1 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) templateId S 1..1
II @root 1..1
string Fixed Value: 2.16.840.1.113883.10.12.303 @classCode 1..1
code Binding: CDAActClassObservation (required )Fixed Value: OBS @moodCode 1..1
code Binding: urn:oid:2.16.840.1.113883.1.11.18943 (required ): x_ActMoodDocumentObservationid 0..*
II code 1..1
CD Binding: ObservationType (example )text 0..1
ED statusCode 0..1
CS Binding: ActStatus (required ): ActStatuseffectiveTime 0..1
IVL_TS
Terminology Bindings
Path Conformance ValueSet / Code URI Observation.classCode required Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCode required urn:oid:2.16.840.1.113883.1.11.18943
urn:oid:2.16.840.1.113883.1.11.18943
Observation.code example ObservationType http://terminology.hl7.org/ValueSet/v3-ObservationType
Observation.statusCode required ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
Snapshot View
Name Flags Card. Type Description & Constraints Observation 0..*
Observation XML Namespace: urn:hl7-org:v3@nullFlavor , realmCode , typeId , templateId , @classCode , @moodCode , @negationInd , id , code , derivationExpr , text , statusCode , effectiveTime , priorityCode , repeatNumber , languageCode , value , interpretationCode , methodCode , targetSiteCode , subject , specimen , performer , author , informant , participant , entryRelationship , reference , precondition , sdtcPrecondition2 , referenceRange , sdtcInFulfillmentOf1 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) @nullFlavor 0..1
cs Binding: CDANullFlavor (required )realmCode 0..*
CS typeId 0..1
II @nullFlavor 0..1
cs Binding: CDANullFlavor (required )@assigningAuthorityName 0..1
st @displayable 0..1
bl @root 1..1
oid , uuid , ruid Fixed Value: 2.16.840.1.113883.1.3 @extension 1..1
st templateId S 1..1
II @nullFlavor 0..1
cs Binding: CDANullFlavor (required )@assigningAuthorityName 0..1
st @displayable 0..1
bl @root 1..1
string Fixed Value: 2.16.840.1.113883.10.12.303 @extension 0..1
st @classCode 1..1
code Binding: CDAActClassObservation (required )Fixed Value: OBS @moodCode 1..1
code Binding: urn:oid:2.16.840.1.113883.1.11.18943 (required ): x_ActMoodDocumentObservation@negationInd 0..1
bl id 0..*
II code 1..1
CD Binding: ObservationType (example )derivationExpr 0..1
ST text 0..1
ED statusCode 0..1
CS Binding: ActStatus (required ): ActStatuseffectiveTime 0..1
IVL_TS priorityCode 0..1
CE Binding: ActPriority (example )repeatNumber 0..1
IVL_INT languageCode 0..1
CS Binding: AllLanguages (required )value 0..*
value ANY value BL value ED value ST value CD value CV value CE value CO value SC value II value TEL value AD value EN value INT value REAL value PQ value MO value TS value IVL_PQ value IVL_TS value PIVL_TS value EIVL_TS value SXPR_TS value RTO_PQ_PQ interpretationCode 0..*
CE Binding: CDAObservationInterpretation (required )methodCode 0..*
CE Binding: ObservationMethod (example )targetSiteCode 0..*
CD subject 0..1
Subject specimen 0..*
Specimen performer 0..*
Performer2 author 0..*
Author informant 0..*
Informant participant 0..*
Participant2 entryRelationship 0..*
EntryRelationship reference 0..*
Reference precondition 0..*
Precondition sdtcPrecondition2 0..*
Precondition2 XML Namespace: urn:hl7-org:sdtcXML: precondition2 (urn:hl7-org:sdtc)referenceRange 0..*
InfrastructureRoot @nullFlavor 0..1
cs Binding: CDANullFlavor (required )realmCode 0..*
CS typeId 0..1
II @nullFlavor 0..1
cs Binding: CDANullFlavor (required )@assigningAuthorityName 0..1
st @displayable 0..1
bl @root 1..1
oid , uuid , ruid Fixed Value: 2.16.840.1.113883.1.3 @extension 1..1
st templateId 0..*
II @typeCode 0..1
cs Binding: CDAActRelationshipType (required )Fixed Value: REFV observationRange 1..1
ObservationRange sdtcInFulfillmentOf1 0..*
InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtcXML: inFulfillmentOf1 (urn:hl7-org:sdtc)
Terminology Bindings
Path Conformance ValueSet / Code URI Observation.nullFlavor required CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.typeId.nullFlavor required CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.templateId.nullFlavor required CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.classCode required Fixed Value: OBShttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCode required urn:oid:2.16.840.1.113883.1.11.18943
urn:oid:2.16.840.1.113883.1.11.18943
Observation.code example ObservationType http://terminology.hl7.org/ValueSet/v3-ObservationType
Observation.statusCode required ActStatus http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.priorityCode example ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Observation.languageCode required AllLanguages http://hl7.org/fhir/ValueSet/all-languages
Observation.interpretationCode required CDAObservationInterpretation http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
Observation.methodCode example ObservationMethod http://terminology.hl7.org/ValueSet/v3-ObservationMethod
Observation.referenceRange.nullFlavor required CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeId.nullFlavor required CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeCode required Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType
This structure is derived from Observation
Summary
Mandatory: 4 elements
Other representations of profile: CSV , Excel
|
|
Propose a change 
