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 Reaction Manifestation

Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.6--20240804101847 Version: 1.1.0-ballot
Draft as of 2024-08-04 Computable Name: IPSAdverseReactionMFST
Other Identifiers: OID:2.16.840.1.113883.10.22.4.6 (use: official, )

This clinical statement represents the response to an undesired symptom, finding, etc. due to administered or exposed substance. This reaction may be an undesired symptom, finding, etc. or it could be a desired response to a treatment. A reaction can be defined with respect to its severity, and can have been treated by one or more interventions.

Usage:

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 S 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)
... @classCode 0..1 code Fixed Value: OBS
... @moodCode 1..1 code Fixed Value: EVN
... 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.6
... code S 1..1 CD Binding: IPS Problem Type (required): Problem Type

... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... statusCode S 0..1 CS
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 1..1 IVL_TS
.... low S 1..1 IVXB_TS
.... high 0..1 IVXB_TS
... value S 1..1 ANY, 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, RTO_PQ_PQ Binding: IPS Allergy Reaction (preferred): IPS Allergy Reaction

​.... @type 1..1 code XML Namespace: http://www.w3.org/2001/XMLSchema-instance
XML: xsi (http://www.w3.org/2001/XMLSchema-instance)
Fixed Value: CD
​.... originalText S 0..1
​..... reference S 0..1
​.... translation 0..*
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..1 EntryRelationship entryRelationship-1: contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
..... Slices for observation Content/Rules for all slices
​...... observation:entryRelationship-1 S 1..1 EntrySeverity
..... @typeCode 1..1 code Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.coderequiredIPSProblemType
http://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips
from this IG
Observation.valuepreferredIPSAllergyReaction
http://hl7.org/fhir/ips/ValueSet/allergy-reaction-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation S 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.6
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
... code S 1..1 CD Binding: IPS Problem Type (required): Problem Type

... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... statusCode S 0..1 CS Binding: ActStatus (required)
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 1..1 IVL_TS
.... low S 1..1 IVXB_TS
.... high 0..1 IVXB_TS
... value S 1..1 Binding: IPS Allergy Reaction (preferred): IPS Allergy Reaction


.... 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
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..1 EntryRelationship entryRelationship-1: contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.classCoderequiredCDAActClassObservation
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredXActMoodDocumentObservation
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.coderequiredIPSProblemType
http://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips
from this IG
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.valuepreferredIPSAllergyReaction
http://hl7.org/fhir/ips/ValueSet/allergy-reaction-uv-ips
from this IG
Observation.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation S 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.6
..... @extension 0..1 st
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
... @negationInd 0..1 bl
... id S 0..* II
... code S 1..1 CD Binding: IPS Problem Type (required): Problem Type

... derivationExpr 0..1 ST
... text S 0..1 ED
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference S 1..1 TEL
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @value 1..1 url
..... useablePeriod 0..*
...... useablePeriod IVL_TS
...... useablePeriod EIVL_TS
...... useablePeriod PIVL_TS
...... useablePeriod SXPR_TS
..... @use 0..* cs Binding: TelecommunicationAddressUse (2.0.0) (required)
.... thumbnail 0..1 ED
... statusCode S 0..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Fixed Value: completed
.... @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)
... effectiveTime S 1..1 IVL_TS
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1 cs Binding: CDASetOperator (required)
.... low S 1..1 IVXB_TS
.... center 0..1 TS
.... width 0..1 PQ
.... high 0..1 IVXB_TS
... priorityCode 0..1 CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... languageCode 0..1 CS Binding: AllLanguages (required)
... value S 1..1 Binding: IPS Allergy Reaction (preferred): IPS Allergy Reaction


.... valueAll Types Content/Rules for all Types
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..1 EntryRelationship entryRelationship-1: contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
..... @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: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... 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 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: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.classCoderequiredCDAActClassObservation
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredXActMoodDocumentObservation
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.coderequiredIPSProblemType
http://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips
from this IG
Observation.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Observation.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Observation.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Observation.text.reference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.text.reference.userequiredTelecommunicationAddressUse
http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.effectiveTime.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
Observation.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Observation.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
Observation.valuepreferredIPSAllergyReaction
http://hl7.org/fhir/ips/ValueSet/allergy-reaction-uv-ips
from this IG
Observation.interpretationCoderequiredCDAObservationInterpretation
http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
Observation.methodCodeexampleObservationMethod
http://terminology.hl7.org/ValueSet/v3-ObservationMethod
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: SUBJ
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

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
:
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Observation

Summary

Mandatory: 8 elements(7 nested mandatory elements)
Must-Support: 13 elements
Fixed: 7 elements

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 S 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)
... @classCode 0..1 code Fixed Value: OBS
... @moodCode 1..1 code Fixed Value: EVN
... 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.6
... code S 1..1 CD Binding: IPS Problem Type (required): Problem Type

... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... statusCode S 0..1 CS
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 1..1 IVL_TS
.... low S 1..1 IVXB_TS
.... high 0..1 IVXB_TS
... value S 1..1 ANY, 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, RTO_PQ_PQ Binding: IPS Allergy Reaction (preferred): IPS Allergy Reaction

​.... @type 1..1 code XML Namespace: http://www.w3.org/2001/XMLSchema-instance
XML: xsi (http://www.w3.org/2001/XMLSchema-instance)
Fixed Value: CD
​.... originalText S 0..1
​..... reference S 0..1
​.... translation 0..*
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..1 EntryRelationship entryRelationship-1: contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
..... Slices for observation Content/Rules for all slices
​...... observation:entryRelationship-1 S 1..1 EntrySeverity
..... @typeCode 1..1 code Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.coderequiredIPSProblemType
http://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips
from this IG
Observation.valuepreferredIPSAllergyReaction
http://hl7.org/fhir/ips/ValueSet/allergy-reaction-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation S 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.6
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
... code S 1..1 CD Binding: IPS Problem Type (required): Problem Type

... text S 0..1 ED
.... reference S 1..1 TEL
..... @value 1..1 url
... statusCode S 0..1 CS Binding: ActStatus (required)
.... @code 0..1 cs Fixed Value: completed
... effectiveTime S 1..1 IVL_TS
.... low S 1..1 IVXB_TS
.... high 0..1 IVXB_TS
... value S 1..1 Binding: IPS Allergy Reaction (preferred): IPS Allergy Reaction


.... 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
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..1 EntryRelationship entryRelationship-1: contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.classCoderequiredCDAActClassObservation
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredXActMoodDocumentObservation
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.coderequiredIPSProblemType
http://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips
from this IG
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.valuepreferredIPSAllergyReaction
http://hl7.org/fhir/ips/ValueSet/allergy-reaction-uv-ips
from this IG
Observation.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation S 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.6
..... @extension 0..1 st
... @classCode 1..1 cs Binding: CDAActClassObservation (required)
... @moodCode 1..1 cs Binding: XActMoodDocumentObservation (2.0.0) (required)
... @negationInd 0..1 bl
... id S 0..* II
... code S 1..1 CD Binding: IPS Problem Type (required): Problem Type

... derivationExpr 0..1 ST
... text S 0..1 ED
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference S 1..1 TEL
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @value 1..1 url
..... useablePeriod 0..*
...... useablePeriod IVL_TS
...... useablePeriod EIVL_TS
...... useablePeriod PIVL_TS
...... useablePeriod SXPR_TS
..... @use 0..* cs Binding: TelecommunicationAddressUse (2.0.0) (required)
.... thumbnail 0..1 ED
... statusCode S 0..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Fixed Value: completed
.... @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)
... effectiveTime S 1..1 IVL_TS
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1 cs Binding: CDASetOperator (required)
.... low S 1..1 IVXB_TS
.... center 0..1 TS
.... width 0..1 PQ
.... high 0..1 IVXB_TS
... priorityCode 0..1 CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... languageCode 0..1 CS Binding: AllLanguages (required)
... value S 1..1 Binding: IPS Allergy Reaction (preferred): IPS Allergy Reaction


.... valueAll Types Content/Rules for all Types
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..1 EntryRelationship entryRelationship-1: contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
..... @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: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... 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 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: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.classCoderequiredCDAActClassObservation
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Observation.moodCoderequiredXActMoodDocumentObservation
http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0
Observation.coderequiredIPSProblemType
http://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips
from this IG
Observation.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Observation.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Observation.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Observation.text.reference.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.text.reference.userequiredTelecommunicationAddressUse
http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.effectiveTime.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
Observation.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Observation.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
Observation.valuepreferredIPSAllergyReaction
http://hl7.org/fhir/ips/ValueSet/allergy-reaction-uv-ips
from this IG
Observation.interpretationCoderequiredCDAObservationInterpretation
http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
Observation.methodCodeexampleObservationMethod
http://terminology.hl7.org/ValueSet/v3-ObservationMethod
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: SUBJ
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

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Severity Observation 2.16.840.1.113883.10.22.4.25 (2017-04-07)
:
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Observation

Summary

Mandatory: 8 elements(7 nested mandatory elements)
Must-Support: 13 elements
Fixed: 7 elements

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