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 and Intolerance Concern

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

This template reflects an ongoing concern on behalf of the person that placed the allergy on a patient’s allergy list. A concern may refer to one or more allergies or intolerances. There are different kinds of status that could be related to an allergy, or more in general to a condition:

  • The status of the concern (active, inactive,..)
  • The status of the condition (e.g. active, inactive, resolved,..)
  • The confirmation status [clinical workflow status, certainty] (e.g. confirmed, likely, unlikely,…)

Not all of them can be represented in a CDA using the statusCode elements of the concern (ACT) and observation (condition).

As long as the underlying condition is of concern to the author (i.e., as long as the allergy, whether active or resolved, is of ongoing concern and interest to the author), the statusCode is “active”.

In case the clinician deems that there is no longer any need to track the underlying conditions then the concern is inactive and the statusCode is set to “completed”. The effectiveTime/low of the Allergy Concern Act asserts when the concern became active. This equates to the time the concern was authored in the patient’s chart. The effectiveTime/high asserts when the concern became inactive, and it is present if the statusCode of the concern act is “completed”

Usage:

Formal Views of Template Content

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

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act S 0..* Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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.5
... @classCode 1..1 code Fixed Value: ACT
... @moodCode 1..1 code Fixed Value: EVN
... code S 1..1 CD
.... @code 0..1 cs Fixed Value: CONC
.... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.6
... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... effectiveTime S 1..1 IVL_TS
.... low S 1..1 IVXB_TS
.... high C 0..1 IVXB_TS MD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:resolve()
.... entryRelationship:entryRelationship-1 SC 1..* EntryRelationship entryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04)
..... @typeCode 1..1 code Fixed Value: SUBJ
..... @inversionInd 0..1 boolean Fixed Value: false
..... observation S 1..1 IPSEntryAllergyOrIntolerance Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Act.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l352l30l19l10l12errorAct.effectiveTime.highIf statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
:
entryRelationship-1nullAct.entryRelationship:entryRelationship-1contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act S 0..* Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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.5
... @classCode 1..1 code Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 code Binding: XDocumentActMood (2.0.0) (required)
Fixed Value: EVN
... code S 1..1 CD Binding: v3 Code System ActCode (example)
.... @code 0..1 cs Fixed Value: CONC
.... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.6
... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... effectiveTime S 1..1 IVL_TS
.... low S 1..1 IVXB_TS
.... high C 0..1 IVXB_TS MD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:resolve()
.... entryRelationship:entryRelationship-1 SC 1..* EntryRelationship entryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 0..1 boolean Fixed Value: false
..... observation S 1..1 IPSEntryAllergyOrIntolerance Base for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete
Act.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l352l30l19l10l12errorAct.effectiveTime.highIf statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
:
entryRelationship-1nullAct.entryRelationship:entryRelationship-1contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04)
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act S 0..* Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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
.... 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.5
..... @extension 0..1 st
... @classCode 1..1 code Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 code Binding: XDocumentActMood (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1 bl
... id S 0..* II
... code S 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Fixed Value: CONC
.... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.6
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... qualifier 0..* CR
.... translation 0..* CD
... text 0..1 ED
... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... 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 C 0..1 IVXB_TS MD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
... priorityCode 0..1 CE Binding: ActPriority (example)
... languageCode 0..1 CS Binding: AllLanguages (required)
... 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:resolve()
.... entryRelationship:entryRelationship-1 SC 1..* EntryRelationship entryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (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: SUBJ
..... @inversionInd 0..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 S 1..1 IPSEntryAllergyOrIntolerance 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
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete
Act.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.effectiveTime.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
Act.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Act.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
Act.entryRelationship:entryRelationship-1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:entryRelationship-1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l352l30l19l10l12errorAct.effectiveTime.highIf statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
:
entryRelationship-1nullAct.entryRelationship:entryRelationship-1contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04)
:

This structure is derived from Act

Summary

Mandatory: 13 elements
Must-Support: 8 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 Act.templateId
  • The element 1 is sliced based on the value of Act.entryRelationship

Differential View

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act S 0..* Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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.5
... @classCode 1..1 code Fixed Value: ACT
... @moodCode 1..1 code Fixed Value: EVN
... code S 1..1 CD
.... @code 0..1 cs Fixed Value: CONC
.... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.6
... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... effectiveTime S 1..1 IVL_TS
.... low S 1..1 IVXB_TS
.... high C 0..1 IVXB_TS MD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:resolve()
.... entryRelationship:entryRelationship-1 SC 1..* EntryRelationship entryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04)
..... @typeCode 1..1 code Fixed Value: SUBJ
..... @inversionInd 0..1 boolean Fixed Value: false
..... observation S 1..1 IPSEntryAllergyOrIntolerance Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Act.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l352l30l19l10l12errorAct.effectiveTime.highIf statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
:
entryRelationship-1nullAct.entryRelationship:entryRelationship-1contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04)
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act S 0..* Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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.5
... @classCode 1..1 code Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 code Binding: XDocumentActMood (2.0.0) (required)
Fixed Value: EVN
... code S 1..1 CD Binding: v3 Code System ActCode (example)
.... @code 0..1 cs Fixed Value: CONC
.... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.6
... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... effectiveTime S 1..1 IVL_TS
.... low S 1..1 IVXB_TS
.... high C 0..1 IVXB_TS MD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by value:resolve()
.... entryRelationship:entryRelationship-1 SC 1..* EntryRelationship entryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04)
..... @typeCode 1..1 code Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 0..1 boolean Fixed Value: false
..... observation S 1..1 IPSEntryAllergyOrIntolerance Base for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete
Act.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l352l30l19l10l12errorAct.effectiveTime.highIf statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
:
entryRelationship-1nullAct.entryRelationship:entryRelationship-1contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04)
:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act S 0..* Act XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, 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
.... 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.5
..... @extension 0..1 st
... @classCode 1..1 code Binding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1 code Binding: XDocumentActMood (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1 bl
... id S 0..* II
... code S 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Fixed Value: CONC
.... @codeSystem 0..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.5.6
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... qualifier 0..* CR
.... translation 0..* CD
... text 0..1 ED
... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... 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 C 0..1 IVXB_TS MD1557037N1l27l352l30l19l10l12: If statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
... priorityCode 0..1 CE Binding: ActPriority (example)
... languageCode 0..1 CS Binding: AllLanguages (required)
... 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:resolve()
.... entryRelationship:entryRelationship-1 SC 1..* EntryRelationship entryRelationship-1: contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (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: SUBJ
..... @inversionInd 0..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 S 1..1 IPSEntryAllergyOrIntolerance 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
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete
Act.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.effectiveTime.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
Act.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Act.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
Act.entryRelationship:entryRelationship-1.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:entryRelationship-1.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.entryRelationship:entryRelationship-1.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
MD1557037N1l27l352l30l19l10l12errorAct.effectiveTime.highIf statusCode/@code="completed" Completed, then effectiveTime *SHALL* contain [1..1] high
:
entryRelationship-1nullAct.entryRelationship:entryRelationship-1contains IPS Allergy or Intolerance 2.16.840.1.113883.10.22.4.1 (2024-08-04)
:

This structure is derived from Act

Summary

Mandatory: 13 elements
Must-Support: 8 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 Act.templateId
  • The element 1 is sliced based on the value of Act.entryRelationship

 

Other representations of profile: CSV, Excel