International Patient Summary (IPS)
1.1.0-ballot - CI Build

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 Result Observation

Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.10--20170302000000 Version: 1.1.0-ballot
Draft as of 2017-03-02 Computable Name: IPSResultObservation
Other Identifiers: OID:2.16.840.1.113883.10.22.4.10 (use: official, )

This generic template is the basic set of constraints, which apply to any kind of observation grouped in a Result Organizer. The IPS Result Observation template is generic. It is further specialized by child templates, which  constrain  clinical laboratory observations or radiology observations or anatomic pathology observations. The generic IPS Result Observation template is usable in a patient summary for observations, which do not fall within one of the specialized categories.   The result observation includes a statusCode to allow recording the status of an observation. “Pending” results (e.g., a test has been run but results have not been reported yet) should be represented as “active” ActStatus. However, in most cases, observations selected for an international patient summary are  results that are final and approved, and thus, have a “completed” statusCode. The result of the observation may be commented through an entryRelationship introducing an “IPS Comment activity” template.

Usage:

  • This Logical Model is not used by any profiles in this Implementation Guide

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@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)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:primary S 1..1 II
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.10
... @classCode 1..1 code Fixed Value: OBS
... @moodCode 1..1 code Fixed Value: EVN
... code S 1..1 CD Binding: IPS Results Observation (required): IPS Results Observation

... statusCode S 1..1 CS
... effectiveTime S 1..1 IVL_TS
... interpretationCode S 0..1 CE Binding: v2 ABNORMAL FLAGS (required): ObservationInterpretation

... targetSiteCode 0..1 CD Binding: IPS Body Site (preferred): IPS Body Site

... author S 0..* Author
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
..... @typeCode 1..1 code Fixed Value: COMP
..... Slices for act Content/Rules for all slices
...... act:entryRelationship-1 1..1 IPSCommentActivity Base for all types and resources
... referenceRange S 0..* InfrastructureRoot
.... observationRange S 1..1 ObservationRange
..... code 0..0
..... value S 1..1 BL, ED, ST, CD, CV, CE, CO, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS
..... interpretationCode 0..1 CE
...... @code 0..1 cs Fixed Value: N
...... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.83

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.coderequiredIPSResultsObservation (a valid code from LOINC)
http://hl7.org/fhir/uv/ips/ValueSet/observation-codes-uv-ips
from this IG
Observation.interpretationCoderequiredv2.0078
http://terminology.hl7.org/ValueSet/v2-0078
from the FHIR Standard
Observation.targetSiteCodepreferredIPSTargetSiteCode
http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@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)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:primary S 1..1 II
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.10
... @classCode 1..1 code Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 code Binding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... code S 1..1 CD Binding: IPS Results Observation (required): IPS Results Observation

... statusCode S 1..1 CS Binding: ActStatus (required)
... effectiveTime S 1..1 IVL_TS
... interpretationCode S 0..1 CE Binding: v2 ABNORMAL FLAGS (required): ObservationInterpretation


... targetSiteCode 0..1 CD Binding: IPS Body Site (preferred): IPS Body Site


... author S 0..* Author
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... Slices for act Content/Rules for all slices
...... act:entryRelationship-1 1..1 IPSCommentActivity Base for all types and resources
... referenceRange S 0..* InfrastructureRoot
.... observationRange S 1..1 ObservationRange
..... value S 1..1
...... 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
..... interpretationCode 0..1 CE Binding: CDAObservationInterpretation (required)
...... @code 0..1 cs Fixed Value: N
...... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.83

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.coderequiredIPSResultsObservation (a valid code from LOINC)
http://hl7.org/fhir/uv/ips/ValueSet/observation-codes-uv-ips
from this IG
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.interpretationCoderequiredv2.0078
http://terminology.hl7.org/ValueSet/v2-0078
from the FHIR Standard
Observation.targetSiteCodepreferredIPSTargetSiteCode
http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips
from this IG
Observation.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: COMP
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.referenceRange.observationRange.interpretationCoderequiredCDAObservationInterpretation
http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@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)
... @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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:primary 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.22.4.10
..... @extension 0..1 st
... @classCode 1..1 code Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 code Binding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1 bl
... id S 0..* II
... code S 1..1 CD Binding: IPS Results Observation (required): IPS Results Observation

... derivationExpr 0..1 ST
... text 0..1 ED
... statusCode S 1..1 CS Binding: ActStatus (required)
... effectiveTime S 1..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 S 0..1 CE Binding: v2 ABNORMAL FLAGS (required): ObservationInterpretation


... methodCode 0..* CE Binding: ObservationMethod (example)
... targetSiteCode 0..1 CD Binding: IPS Body Site (preferred): IPS Body Site


... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author S 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
..... @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 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... Slices for act Content/Rules for all slices
...... act:entryRelationship-1 1..1 IPSCommentActivity Base for all types and resources
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange S 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 S 1..1 ObservationRange
..... @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
..... @classCode 0..1 cs Binding: CDAActClassObservation (required)
..... @moodCode 0..1 cs Binding: ActMoodPredicate (required)
Fixed Value: EVN.CRT
..... text 0..1 ED
..... value S 1..1
...... 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
..... interpretationCode 0..1 CE Binding: CDAObservationInterpretation (required)
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @code 0..1 cs Fixed Value: N
...... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.83
...... @codeSystemName 0..1 st
...... @codeSystemVersion 0..1 st
...... @displayName 0..1 st
...... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1 ED
...... translation 0..* CD
..... sdtcPrecondition1 0..* InfrastructureRoot XML Namespace: urn:hl7-org:sdtc
XML: precondition1 (urn:hl7-org:sdtc)
...... @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: PRCN
...... conjunctionCode 1..1 CS XML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
Binding: RelationshipConjunction (2.0.0) (required)
...... criterion1 1..1 Criterion XML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.coderequiredIPSResultsObservation (a valid code from LOINC)
http://hl7.org/fhir/uv/ips/ValueSet/observation-codes-uv-ips
from this IG
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Observation.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
Observation.interpretationCoderequiredv2.0078
http://terminology.hl7.org/ValueSet/v2-0078
from the FHIR Standard
Observation.methodCodeexampleObservationMethod
http://terminology.hl7.org/ValueSet/v3-ObservationMethod
Observation.targetSiteCodepreferredIPSTargetSiteCode
http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips
from this IG
Observation.entryRelationship:entryRelationship-1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: COMP
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV
http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType
Observation.referenceRange.observationRange.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.observationRange.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.observationRange.classCoderequiredCDAActClassObservation
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.referenceRange.observationRange.moodCoderequiredFixed Value: EVN.CRT
http://terminology.hl7.org/ValueSet/v3-ActMoodPredicate
Observation.referenceRange.observationRange.interpretationCoderequiredCDAObservationInterpretation
http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
Observation.referenceRange.observationRange.interpretationCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.observationRange.sdtcPrecondition1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.observationRange.sdtcPrecondition1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.observationRange.sdtcPrecondition1.typeCoderequiredFixed Value: PRCN
http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType
Observation.referenceRange.observationRange.sdtcPrecondition1.conjunctionCoderequiredRelationshipConjunction
http://terminology.hl7.org/ValueSet/v3-RelationshipConjunction|2.0.0

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
:

This structure is derived from Observation

Summary

Mandatory: 9 elements(4 nested mandatory elements)
Must-Support: 10 elements
Fixed: 6 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Observation.templateId
  • The element 1 is sliced based on the value of Observation.entryRelationship

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@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)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:primary S 1..1 II
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.10
... @classCode 1..1 code Fixed Value: OBS
... @moodCode 1..1 code Fixed Value: EVN
... code S 1..1 CD Binding: IPS Results Observation (required): IPS Results Observation

... statusCode S 1..1 CS
... effectiveTime S 1..1 IVL_TS
... interpretationCode S 0..1 CE Binding: v2 ABNORMAL FLAGS (required): ObservationInterpretation

... targetSiteCode 0..1 CD Binding: IPS Body Site (preferred): IPS Body Site

... author S 0..* Author
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
..... @typeCode 1..1 code Fixed Value: COMP
..... Slices for act Content/Rules for all slices
...... act:entryRelationship-1 1..1 IPSCommentActivity Base for all types and resources
... referenceRange S 0..* InfrastructureRoot
.... observationRange S 1..1 ObservationRange
..... code 0..0
..... value S 1..1 BL, ED, ST, CD, CV, CE, CO, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS
..... interpretationCode 0..1 CE
...... @code 0..1 cs Fixed Value: N
...... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.83

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.coderequiredIPSResultsObservation (a valid code from LOINC)
http://hl7.org/fhir/uv/ips/ValueSet/observation-codes-uv-ips
from this IG
Observation.interpretationCoderequiredv2.0078
http://terminology.hl7.org/ValueSet/v2-0078
from the FHIR Standard
Observation.targetSiteCodepreferredIPSTargetSiteCode
http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@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)
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:primary S 1..1 II
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.10
... @classCode 1..1 code Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 code Binding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... code S 1..1 CD Binding: IPS Results Observation (required): IPS Results Observation

... statusCode S 1..1 CS Binding: ActStatus (required)
... effectiveTime S 1..1 IVL_TS
... interpretationCode S 0..1 CE Binding: v2 ABNORMAL FLAGS (required): ObservationInterpretation


... targetSiteCode 0..1 CD Binding: IPS Body Site (preferred): IPS Body Site


... author S 0..* Author
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... Slices for act Content/Rules for all slices
...... act:entryRelationship-1 1..1 IPSCommentActivity Base for all types and resources
... referenceRange S 0..* InfrastructureRoot
.... observationRange S 1..1 ObservationRange
..... value S 1..1
...... 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
..... interpretationCode 0..1 CE Binding: CDAObservationInterpretation (required)
...... @code 0..1 cs Fixed Value: N
...... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.83

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.coderequiredIPSResultsObservation (a valid code from LOINC)
http://hl7.org/fhir/uv/ips/ValueSet/observation-codes-uv-ips
from this IG
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.interpretationCoderequiredv2.0078
http://terminology.hl7.org/ValueSet/v2-0078
from the FHIR Standard
Observation.targetSiteCodepreferredIPSTargetSiteCode
http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips
from this IG
Observation.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: COMP
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.referenceRange.observationRange.interpretationCoderequiredCDAObservationInterpretation
http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Observation XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@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)
... @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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:primary 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.22.4.10
..... @extension 0..1 st
... @classCode 1..1 code Binding: CDAActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1 code Binding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1 bl
... id S 0..* II
... code S 1..1 CD Binding: IPS Results Observation (required): IPS Results Observation

... derivationExpr 0..1 ST
... text 0..1 ED
... statusCode S 1..1 CS Binding: ActStatus (required)
... effectiveTime S 1..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 S 0..1 CE Binding: v2 ABNORMAL FLAGS (required): ObservationInterpretation


... methodCode 0..* CE Binding: ObservationMethod (example)
... targetSiteCode 0..1 CD Binding: IPS Body Site (preferred): IPS Body Site


... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author S 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 C 0..* EntryRelationship entryRelationship-1: contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
..... @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 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @inversionInd 0..1 bl
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... Slices for act Content/Rules for all slices
...... act:entryRelationship-1 1..1 IPSCommentActivity Base for all types and resources
..... encounter 0..1 Encounter
..... observation 0..1 Observation
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange S 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 S 1..1 ObservationRange
..... @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
..... @classCode 0..1 cs Binding: CDAActClassObservation (required)
..... @moodCode 0..1 cs Binding: ActMoodPredicate (required)
Fixed Value: EVN.CRT
..... text 0..1 ED
..... value S 1..1
...... 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
..... interpretationCode 0..1 CE Binding: CDAObservationInterpretation (required)
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @code 0..1 cs Fixed Value: N
...... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.83
...... @codeSystemName 0..1 st
...... @codeSystemVersion 0..1 st
...... @displayName 0..1 st
...... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
...... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
...... originalText 0..1 ED
...... translation 0..* CD
..... sdtcPrecondition1 0..* InfrastructureRoot XML Namespace: urn:hl7-org:sdtc
XML: precondition1 (urn:hl7-org:sdtc)
...... @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: PRCN
...... conjunctionCode 1..1 CS XML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
Binding: RelationshipConjunction (2.0.0) (required)
...... criterion1 1..1 Criterion XML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.classCoderequiredFixed Value: OBS
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.coderequiredIPSResultsObservation (a valid code from LOINC)
http://hl7.org/fhir/uv/ips/ValueSet/observation-codes-uv-ips
from this IG
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Observation.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
Observation.interpretationCoderequiredv2.0078
http://terminology.hl7.org/ValueSet/v2-0078
from the FHIR Standard
Observation.methodCodeexampleObservationMethod
http://terminology.hl7.org/ValueSet/v3-ObservationMethod
Observation.targetSiteCodepreferredIPSTargetSiteCode
http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips
from this IG
Observation.entryRelationship:entryRelationship-1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: COMP
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV
http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType
Observation.referenceRange.observationRange.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.observationRange.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.observationRange.classCoderequiredCDAActClassObservation
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.referenceRange.observationRange.moodCoderequiredFixed Value: EVN.CRT
http://terminology.hl7.org/ValueSet/v3-ActMoodPredicate
Observation.referenceRange.observationRange.interpretationCoderequiredCDAObservationInterpretation
http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
Observation.referenceRange.observationRange.interpretationCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.observationRange.sdtcPrecondition1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.observationRange.sdtcPrecondition1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.referenceRange.observationRange.sdtcPrecondition1.typeCoderequiredFixed Value: PRCN
http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType
Observation.referenceRange.observationRange.sdtcPrecondition1.conjunctionCoderequiredRelationshipConjunction
http://terminology.hl7.org/ValueSet/v3-RelationshipConjunction|2.0.0

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Comment Activity 2.16.840.1.113883.10.22.4.22 (2017-04-05)
:

This structure is derived from Observation

Summary

Mandatory: 9 elements(4 nested mandatory elements)
Must-Support: 10 elements
Fixed: 6 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Observation.templateId
  • The element 1 is sliced based on the value of Observation.entryRelationship

 

Other representations of profile: CSV, Excel