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 Allergy or Intolerance

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

This template reflects a discrete observation about a patient’s allergy or intolerance.

Because it is a discrete observation, it will have a statusCode of “completed”.

The effectiveTime, also referred to as the “biologically relevant time” is the time at which the observation holds for the patient.

For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago.

The effectiveTime of the Allergy - Intolerance Observation gives an indication of whether or not the underlying allergy/intolerance is resolved. If known to be resolved, then an effectiveTime/high would be present. 

If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of “UNK”.  It is recommended that the agent responsible for an allergy or adverse reaction would be used for describing the allergy, however the possibility that pre-coordinate codes (e.g. “allergy to nuts”) will be used has been here also considered. The agent responsible for  an allergy or adverse reaction it is not always a manufactured material (for example, food allergies), nor is it necessarily consumed; however  the playingEntity classCode = “MMAT” for all agents, manufactured or not is expected to be used. This choice depends on thecharacteristics of the base CDA R2 specification.

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)
... 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.1
... @classCode 1..1 code Fixed Value: OBS
... @moodCode 1..1 code Fixed Value: EVN
... code S 1..1 CD Binding: Allergy or Intolerance Type (required): Allergy or Intolerance Type

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

... participant 0..1 Participant2
.... @typeCode 1..1 code Fixed Value: CSM
.... participantRole S 1..1 ParticipantRole
..... @classCode 1..1 code Fixed Value: MANU
..... playingEntity S 1..1 PlayingEntity
...... @classCode 1..1 code Fixed Value: MMAT
...... code S 1..1 CE Binding: IPS Allergy or Intolerance Substances (preferred): IPS Allergy or Intolerance Substances

... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..* EntryRelationship entryRelationship-1: contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
..... @typeCode 1..1 code Fixed Value: MFST
..... @inversionInd 1..1 boolean Fixed Value: true
..... Slices for observation Content/Rules for all slices
...... observation:entryRelationship-1 S 1..1 IPSAdverseReactionMFST Base for all types and resources
.... entryRelationship:entryRelationship-2 SC 1..1 EntryRelationship entryRelationship-2: contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
..... @typeCode 1..1 code Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true
.... entryRelationship:entryRelationship-3 SC 1..1 EntryRelationship entryRelationship-3: contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07)
..... @typeCode 1..1 code Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true
.... entryRelationship:entryRelationship-4 SC 1..1 EntryRelationship entryRelationship-4: contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
..... @typeCode 1..1 code Fixed Value: REFR
..... @inversionInd 1..1 boolean Fixed Value: false

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.coderequiredAllergyOrIntollerance_VS
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.2--20161206000000
from this IG
Observation.valuepreferredIPSAllergyOrIntoleranceConditions
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.10--20240802091633
from this IG
Observation.participant.participantRole.playingEntity.codepreferredAllergyintolerancesubstancecondition
http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
:
entryRelationship-2nullObservation.entryRelationship:entryRelationship-2contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
:
entryRelationship-3nullObservation.entryRelationship:entryRelationship-3contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07)
:
entryRelationship-4nullObservation.entryRelationship:entryRelationship-4contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
:
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.1
... @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: Allergy or Intolerance Type (required): Allergy or Intolerance Type

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


.... 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
... participant 0..1 Participant2
.... @typeCode 1..1 code Binding: CDAParticipationType (required)
Fixed Value: CSM
.... participantRole S 1..1 ParticipantRole
..... @classCode 1..1 code Binding: CDARoleClassRoot (required)
Fixed Value: MANU
..... playingEntity S 1..1 PlayingEntity
...... @classCode 1..1 code Binding: EntityClassRoot (required)
Fixed Value: MMAT
...... code S 1..1 CE Binding: IPS Allergy or Intolerance Substances (preferred): IPS Allergy or Intolerance Substances

... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..* EntryRelationship entryRelationship-1: contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: MFST
..... @inversionInd 1..1 boolean Fixed Value: true
..... Slices for observation Content/Rules for all slices
...... observation:entryRelationship-1 S 1..1 IPSAdverseReactionMFST Base for all types and resources
.... entryRelationship:entryRelationship-2 SC 1..1 EntryRelationship entryRelationship-2: contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true
.... entryRelationship:entryRelationship-3 SC 1..1 EntryRelationship entryRelationship-3: contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true
.... entryRelationship:entryRelationship-4 SC 1..1 EntryRelationship entryRelationship-4: contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 1..1 boolean Fixed Value: false

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.coderequiredAllergyOrIntollerance_VS
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.2--20161206000000
from this IG
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.valuepreferredIPSAllergyOrIntoleranceConditions
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.10--20240802091633
from this IG
Observation.participant.typeCoderequiredFixed Value: CSM
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Observation.participant.participantRole.classCoderequiredFixed Value: MANU
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
Observation.participant.participantRole.playingEntity.classCoderequiredFixed Value: MMAT
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Observation.participant.participantRole.playingEntity.codepreferredAllergyintolerancesubstancecondition
http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-uv-ips
from this IG
Observation.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: MFST
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-2.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-3.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-4.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
:
entryRelationship-2nullObservation.entryRelationship:entryRelationship-2contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
:
entryRelationship-3nullObservation.entryRelationship:entryRelationship-3contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07)
:
entryRelationship-4nullObservation.entryRelationship:entryRelationship-4contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
:
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.1
..... @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: Allergy or Intolerance Type (required): Allergy or Intolerance 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 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 code 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 0..1 Binding: IPS Allergy or Intolerance Conditions (preferred): IPS Allergy or Intolerance Conditions


.... 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..1 Participant2
.... @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: CDAParticipationType (required)
Fixed Value: CSM
.... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... awarenessCode 0..1 CE
.... participantRole S 1..1 ParticipantRole
..... @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 1..1 code Binding: CDARoleClassRoot (required)
Fixed Value: MANU
..... id 0..* II
..... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1 CE Binding: CDARoleCode (example)
..... addr 0..* AD
..... telecom 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity S 1..1 PlayingEntity
...... @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 1..1 code Binding: EntityClassRoot (required)
Fixed Value: MMAT
...... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code S 1..1 CE Binding: IPS Allergy or Intolerance Substances (preferred): IPS Allergy or Intolerance Substances

...... quantity 0..* PQ
...... name 0..* PN
...... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
...... desc 0..1 ED
..... scopingEntity 0..1 Entity
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..* EntryRelationship entryRelationship-1: contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
..... @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: MFST
..... @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
..... Slices for observation Content/Rules for all slices
...... observation:entryRelationship-1 S 1..1 IPSAdverseReactionMFST Base for all types and resources
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:entryRelationship-2 SC 1..1 EntryRelationship entryRelationship-2: contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
..... @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
.... entryRelationship:entryRelationship-3 SC 1..1 EntryRelationship entryRelationship-3: contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-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
.... entryRelationship:entryRelationship-4 SC 1..1 EntryRelationship entryRelationship-4: contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
..... @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: REFR
..... @inversionInd 1..1 boolean Fixed Value: false
..... @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.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.coderequiredAllergyOrIntollerance_VS
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.2--20161206000000
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.valuepreferredIPSAllergyOrIntoleranceConditions
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.10--20240802091633
from this IG
Observation.interpretationCoderequiredCDAObservationInterpretation
http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
Observation.methodCodeexampleObservationMethod
http://terminology.hl7.org/ValueSet/v3-ObservationMethod
Observation.participant.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.typeCoderequiredFixed Value: CSM
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Observation.participant.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Observation.participant.participantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.participantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.participantRole.classCoderequiredFixed Value: MANU
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
Observation.participant.participantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
Observation.participant.participantRole.playingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.participantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.participantRole.playingEntity.classCoderequiredFixed Value: MMAT
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Observation.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Observation.participant.participantRole.playingEntity.codepreferredAllergyintolerancesubstancecondition
http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-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: MFST
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-2.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-2.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-2.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-3.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-3.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-3.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-4.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-4.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-4.typeCoderequiredFixed Value: REFR
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
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
:
entryRelationship-2nullObservation.entryRelationship:entryRelationship-2contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
:
entryRelationship-3nullObservation.entryRelationship:entryRelationship-3contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07)
:
entryRelationship-4nullObservation.entryRelationship:entryRelationship-4contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
:

This structure is derived from Observation

Summary

Mandatory: 20 elements(11 nested mandatory elements)
Must-Support: 16 elements
Fixed: 15 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)
... 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.1
... @classCode 1..1 code Fixed Value: OBS
... @moodCode 1..1 code Fixed Value: EVN
... code S 1..1 CD Binding: Allergy or Intolerance Type (required): Allergy or Intolerance Type

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

... participant 0..1 Participant2
.... @typeCode 1..1 code Fixed Value: CSM
.... participantRole S 1..1 ParticipantRole
..... @classCode 1..1 code Fixed Value: MANU
..... playingEntity S 1..1 PlayingEntity
...... @classCode 1..1 code Fixed Value: MMAT
...... code S 1..1 CE Binding: IPS Allergy or Intolerance Substances (preferred): IPS Allergy or Intolerance Substances

... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..* EntryRelationship entryRelationship-1: contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
..... @typeCode 1..1 code Fixed Value: MFST
..... @inversionInd 1..1 boolean Fixed Value: true
..... Slices for observation Content/Rules for all slices
...... observation:entryRelationship-1 S 1..1 IPSAdverseReactionMFST Base for all types and resources
.... entryRelationship:entryRelationship-2 SC 1..1 EntryRelationship entryRelationship-2: contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
..... @typeCode 1..1 code Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true
.... entryRelationship:entryRelationship-3 SC 1..1 EntryRelationship entryRelationship-3: contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07)
..... @typeCode 1..1 code Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true
.... entryRelationship:entryRelationship-4 SC 1..1 EntryRelationship entryRelationship-4: contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
..... @typeCode 1..1 code Fixed Value: REFR
..... @inversionInd 1..1 boolean Fixed Value: false

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.coderequiredAllergyOrIntollerance_VS
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.2--20161206000000
from this IG
Observation.valuepreferredIPSAllergyOrIntoleranceConditions
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.10--20240802091633
from this IG
Observation.participant.participantRole.playingEntity.codepreferredAllergyintolerancesubstancecondition
http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
:
entryRelationship-2nullObservation.entryRelationship:entryRelationship-2contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
:
entryRelationship-3nullObservation.entryRelationship:entryRelationship-3contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07)
:
entryRelationship-4nullObservation.entryRelationship:entryRelationship-4contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
:

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.1
... @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: Allergy or Intolerance Type (required): Allergy or Intolerance Type

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


.... 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
... participant 0..1 Participant2
.... @typeCode 1..1 code Binding: CDAParticipationType (required)
Fixed Value: CSM
.... participantRole S 1..1 ParticipantRole
..... @classCode 1..1 code Binding: CDARoleClassRoot (required)
Fixed Value: MANU
..... playingEntity S 1..1 PlayingEntity
...... @classCode 1..1 code Binding: EntityClassRoot (required)
Fixed Value: MMAT
...... code S 1..1 CE Binding: IPS Allergy or Intolerance Substances (preferred): IPS Allergy or Intolerance Substances

... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..* EntryRelationship entryRelationship-1: contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: MFST
..... @inversionInd 1..1 boolean Fixed Value: true
..... Slices for observation Content/Rules for all slices
...... observation:entryRelationship-1 S 1..1 IPSAdverseReactionMFST Base for all types and resources
.... entryRelationship:entryRelationship-2 SC 1..1 EntryRelationship entryRelationship-2: contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true
.... entryRelationship:entryRelationship-3 SC 1..1 EntryRelationship entryRelationship-3: contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1 boolean Fixed Value: true
.... entryRelationship:entryRelationship-4 SC 1..1 EntryRelationship entryRelationship-4: contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 1..1 boolean Fixed Value: false

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.coderequiredAllergyOrIntollerance_VS
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.2--20161206000000
from this IG
Observation.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Observation.valuepreferredIPSAllergyOrIntoleranceConditions
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.10--20240802091633
from this IG
Observation.participant.typeCoderequiredFixed Value: CSM
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Observation.participant.participantRole.classCoderequiredFixed Value: MANU
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
Observation.participant.participantRole.playingEntity.classCoderequiredFixed Value: MMAT
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Observation.participant.participantRole.playingEntity.codepreferredAllergyintolerancesubstancecondition
http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-uv-ips
from this IG
Observation.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: MFST
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-2.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-3.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-4.typeCoderequiredFixed Value: REFR
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
:
entryRelationship-2nullObservation.entryRelationship:entryRelationship-2contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
:
entryRelationship-3nullObservation.entryRelationship:entryRelationship-3contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07)
:
entryRelationship-4nullObservation.entryRelationship:entryRelationship-4contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
:

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.1
..... @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: Allergy or Intolerance Type (required): Allergy or Intolerance 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 1..1 CS Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 code 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 0..1 Binding: IPS Allergy or Intolerance Conditions (preferred): IPS Allergy or Intolerance Conditions


.... 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..1 Participant2
.... @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: CDAParticipationType (required)
Fixed Value: CSM
.... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
.... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1 IVL_TS
.... awarenessCode 0..1 CE
.... participantRole S 1..1 ParticipantRole
..... @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 1..1 code Binding: CDARoleClassRoot (required)
Fixed Value: MANU
..... id 0..* II
..... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1 CE Binding: CDARoleCode (example)
..... addr 0..* AD
..... telecom 0..* TEL
..... playingDevice 0..1 Device
..... playingEntity S 1..1 PlayingEntity
...... @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 1..1 code Binding: EntityClassRoot (required)
Fixed Value: MMAT
...... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code S 1..1 CE Binding: IPS Allergy or Intolerance Substances (preferred): IPS Allergy or Intolerance Substances

...... quantity 0..* PQ
...... name 0..* PN
...... sdtcBirthTime 0..1 TS XML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
...... desc 0..1 ED
..... scopingEntity 0..1 Entity
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:profile
.... entryRelationship:entryRelationship-1 SC 0..* EntryRelationship entryRelationship-1: contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
..... @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: MFST
..... @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
..... Slices for observation Content/Rules for all slices
...... observation:entryRelationship-1 S 1..1 IPSAdverseReactionMFST Base for all types and resources
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... entryRelationship:entryRelationship-2 SC 1..1 EntryRelationship entryRelationship-2: contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
..... @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
.... entryRelationship:entryRelationship-3 SC 1..1 EntryRelationship entryRelationship-3: contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-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
.... entryRelationship:entryRelationship-4 SC 1..1 EntryRelationship entryRelationship-4: contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
..... @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: REFR
..... @inversionInd 1..1 boolean Fixed Value: false
..... @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.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.coderequiredAllergyOrIntollerance_VS
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.2--20161206000000
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.valuepreferredIPSAllergyOrIntoleranceConditions
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.10--20240802091633
from this IG
Observation.interpretationCoderequiredCDAObservationInterpretation
http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation
Observation.methodCodeexampleObservationMethod
http://terminology.hl7.org/ValueSet/v3-ObservationMethod
Observation.participant.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.typeCoderequiredFixed Value: CSM
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Observation.participant.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Observation.participant.participantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.participantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.participantRole.classCoderequiredFixed Value: MANU
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
Observation.participant.participantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
Observation.participant.participantRole.playingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.participantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.participant.participantRole.playingEntity.classCoderequiredFixed Value: MMAT
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Observation.participant.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Observation.participant.participantRole.playingEntity.codepreferredAllergyintolerancesubstancecondition
http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-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: MFST
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-2.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-2.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-2.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-3.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-3.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-3.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
Observation.entryRelationship:entryRelationship-4.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-4.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Observation.entryRelationship:entryRelationship-4.typeCoderequiredFixed Value: REFR
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
entryRelationship-1nullObservation.entryRelationship:entryRelationship-1contains IPS Reaction Manifestation 2.16.840.1.113883.10.22.4.6 (2024-08-04)
:
entryRelationship-2nullObservation.entryRelationship:entryRelationship-2contains IPS Criticality Observation 2.16.840.1.113883.10.22.4.18 (2017-03-27)
:
entryRelationship-3nullObservation.entryRelationship:entryRelationship-3contains IPS Allergy Certainty Observation 2.16.840.1.113883.10.22.10 (2018-02-07)
:
entryRelationship-4nullObservation.entryRelationship:entryRelationship-4contains IPS Allergy Status Observation 2.16.840.1.113883.10.22.4.21 (2017-05-24)
:

This structure is derived from Observation

Summary

Mandatory: 20 elements(11 nested mandatory elements)
Must-Support: 16 elements
Fixed: 15 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