Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: Allergy Concern Act

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AllergyConcernAct Version: 4.0.0
Draft as of 2025-10-02 Computable Name: AllergyConcernAct
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.30:2015-08-01

This template reflects an ongoing concern on behalf of the provider that placed the allergy on a patient's allergy list. As long as the underlying condition is of concern to the provider (i.e., as long as the allergy, whether active or resolved, is of ongoing concern and interest to the provider), the statusCode is "active". Only when the underlying allergy is no longer of concern is the statusCode set to "completed". The effectiveTime reflects the time that the underlying allergy was felt to be a concern.

The statusCode of the Allergy Concern Act is the definitive indication of the status of the concern, whereas the effectiveTime of the nested Allergy - Intolerance Observation is the definitive indication of whether or not the underlying allergy is resolved.

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 was completed (e.g., when the clinician deemed there is no longer any need to track the underlying condition).

Templates Used

Although open templates may contain any valid CDA content, the following templates are specifically called out by this template:

Required EntryRelationships: AllergyIntoleranceObservation

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 3.0.0:

  • New Content

    • Formal Views of Template Content

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

    This structure is derived from Act

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, 1198-10085, 1198-7504, should-author
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:allergy-concern-act 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.30
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... @classCode 1..1 cs Fixed Value: ACT
    ... @moodCode 1..1 cs Fixed Value: EVN
    ... code 1..1 CD
    .... @code 1..1 cs Required Pattern: CONC
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.6
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    ... statusCode 1..1 CS
    .... @nullFlavor 0..0
    .... @code 1..1 cs Binding: ProblemAct statusCode . (required)
    ... effectiveTime 1..1 IVL_TS
    .... low 0..1 IVXB_TS Required if statusCode = 'active'
    .... high 0..1 IVXB_TS Required if statusCode = 'completed'
    ... author 0..* AuthorParticipation
    ... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation
    .... entryRelationship:allergyObs 1..1 EntryRelationship
    ..... @typeCode 1..1 cs Fixed Value: SUBJ
    ..... observation 1..1 AllergyIntoleranceObservation

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Act.statusCode.code Base required ProblemAct statusCode . 📦20240606 VSAC v0.23

    Constraints

    Id Grade Path(s) Description Expression
    1198-7504 error Act If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). (statusCode.code = 'active') implies effectiveTime.low.exists()
    1198-10085 error Act If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). (statusCode.code = 'completed') implies effectiveTime.high.exists()
    should-author warning Act SHOULD contain author author.exists()
    should-text-ref-value warning Act SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Act.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, 1198-10085, 1198-7504, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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:allergy-concern-act 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.30
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
    Fixed Value: ACT
    ... @moodCode 1..1 cs Binding: XDocumentActMood (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl
    ... id 1..* II
    ... code 1..1 CD Binding: v3 Code System ActCode (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: CONC
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 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 SHOULD reference the portion of section narrative text corresponding to this entry
    .... @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 C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @code 1..1 cs Binding: ProblemAct statusCode . (required)
    .... @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 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 0..1 IVXB_TS Required if statusCode = 'active'
    .... center 0..1 TS
    .... width 0..1 PQ
    .... high 0..1 IVXB_TS Required if statusCode = 'completed'
    ... 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..* AuthorParticipation
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation
    .... entryRelationship:allergyObs 1..1 EntryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 0..1 bl
    ..... @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 1..1 AllergyIntoleranceObservation
    ..... 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

    Path Status Usage ValueSet Version Source
    Act.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.templateId:allergy-concern-act.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.classCode Base required x_ActClassDocumentEntryAct 📍2.0.0 THO v5.2
    Act.moodCode Base required x_DocumentActMood 📍2.0.0 THO v5.2
    Act.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
    Act.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Act.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Act.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Act.statusCode.code Base required ProblemAct statusCode . 📦20240606 VSAC v0.23
    Act.effectiveTime.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.effectiveTime.operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Act.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Act.entryRelationship:allergyObs.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.entryRelationship:allergyObs.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.entryRelationship:allergyObs.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    1198-7504 error Act If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). (statusCode.code = 'active') implies effectiveTime.low.exists()
    1198-10085 error Act If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). (statusCode.code = 'completed') implies effectiveTime.high.exists()
    II-1 error Act.typeId, Act.entryRelationship:allergyObs.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Act SHOULD contain author author.exists()
    should-text-ref-value warning Act SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Act.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, 1198-10085, 1198-7504, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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:allergy-concern-act 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.30
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
    Fixed Value: ACT
    ... @moodCode 1..1 cs Binding: XDocumentActMood (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl
    ... id 1..* II
    ... code 1..1 CD Binding: v3 Code System ActCode (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: CONC
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 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 SHOULD reference the portion of section narrative text corresponding to this entry
    .... @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 C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @code 1..1 cs Binding: ProblemAct statusCode . (required)
    .... @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 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 0..1 IVXB_TS Required if statusCode = 'active'
    .... center 0..1 TS
    .... width 0..1 PQ
    .... high 0..1 IVXB_TS Required if statusCode = 'completed'
    ... 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..* AuthorParticipation
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation
    .... entryRelationship:allergyObs 1..1 EntryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 0..1 bl
    ..... @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 1..1 AllergyIntoleranceObservation
    ..... 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

    Path Status Usage ValueSet Version Source
    Act.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.templateId:allergy-concern-act.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.classCode Base required x_ActClassDocumentEntryAct 📍2.0.0 THO v5.2
    Act.moodCode Base required x_DocumentActMood 📍2.0.0 THO v5.2
    Act.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
    Act.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Act.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Act.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Act.statusCode.code Base required ProblemAct statusCode . 📦20240606 VSAC v0.23
    Act.effectiveTime.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.effectiveTime.operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Act.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Act.entryRelationship:allergyObs.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.entryRelationship:allergyObs.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.entryRelationship:allergyObs.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    1198-7504 error Act If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). (statusCode.code = 'active') implies effectiveTime.low.exists()
    1198-10085 error Act If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). (statusCode.code = 'completed') implies effectiveTime.high.exists()
    II-1 error Act.typeId, Act.entryRelationship:allergyObs.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Act SHOULD contain author author.exists()
    should-text-ref-value warning Act SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Act.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    This structure is derived from Act

    Summary

    Mandatory: 13 elements
    Fixed: 3 elements
    Prohibited: 1 element

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

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

    Differential View

    This structure is derived from Act

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, 1198-10085, 1198-7504, should-author
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:allergy-concern-act 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.30
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... @classCode 1..1 cs Fixed Value: ACT
    ... @moodCode 1..1 cs Fixed Value: EVN
    ... code 1..1 CD
    .... @code 1..1 cs Required Pattern: CONC
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.6
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    ... statusCode 1..1 CS
    .... @nullFlavor 0..0
    .... @code 1..1 cs Binding: ProblemAct statusCode . (required)
    ... effectiveTime 1..1 IVL_TS
    .... low 0..1 IVXB_TS Required if statusCode = 'active'
    .... high 0..1 IVXB_TS Required if statusCode = 'completed'
    ... author 0..* AuthorParticipation
    ... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation
    .... entryRelationship:allergyObs 1..1 EntryRelationship
    ..... @typeCode 1..1 cs Fixed Value: SUBJ
    ..... observation 1..1 AllergyIntoleranceObservation

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Act.statusCode.code Base required ProblemAct statusCode . 📦20240606 VSAC v0.23

    Constraints

    Id Grade Path(s) Description Expression
    1198-7504 error Act If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). (statusCode.code = 'active') implies effectiveTime.low.exists()
    1198-10085 error Act If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). (statusCode.code = 'completed') implies effectiveTime.high.exists()
    should-author warning Act SHOULD contain author author.exists()
    should-text-ref-value warning Act SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Act.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, 1198-10085, 1198-7504, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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:allergy-concern-act 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.30
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
    Fixed Value: ACT
    ... @moodCode 1..1 cs Binding: XDocumentActMood (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl
    ... id 1..* II
    ... code 1..1 CD Binding: v3 Code System ActCode (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: CONC
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 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 SHOULD reference the portion of section narrative text corresponding to this entry
    .... @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 C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @code 1..1 cs Binding: ProblemAct statusCode . (required)
    .... @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 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 0..1 IVXB_TS Required if statusCode = 'active'
    .... center 0..1 TS
    .... width 0..1 PQ
    .... high 0..1 IVXB_TS Required if statusCode = 'completed'
    ... 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..* AuthorParticipation
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation
    .... entryRelationship:allergyObs 1..1 EntryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 0..1 bl
    ..... @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 1..1 AllergyIntoleranceObservation
    ..... 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

    Path Status Usage ValueSet Version Source
    Act.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.templateId:allergy-concern-act.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.classCode Base required x_ActClassDocumentEntryAct 📍2.0.0 THO v5.2
    Act.moodCode Base required x_DocumentActMood 📍2.0.0 THO v5.2
    Act.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
    Act.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Act.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Act.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Act.statusCode.code Base required ProblemAct statusCode . 📦20240606 VSAC v0.23
    Act.effectiveTime.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.effectiveTime.operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Act.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Act.entryRelationship:allergyObs.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.entryRelationship:allergyObs.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.entryRelationship:allergyObs.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    1198-7504 error Act If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). (statusCode.code = 'active') implies effectiveTime.low.exists()
    1198-10085 error Act If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). (statusCode.code = 'completed') implies effectiveTime.high.exists()
    II-1 error Act.typeId, Act.entryRelationship:allergyObs.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Act SHOULD contain author author.exists()
    should-text-ref-value warning Act SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Act.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Act C 1..1 Act XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: should-text-ref-value, 1198-10085, 1198-7504, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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:allergy-concern-act 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.30
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... @classCode 1..1 cs Binding: XActClassDocumentEntryAct (2.0.0) (required)
    Fixed Value: ACT
    ... @moodCode 1..1 cs Binding: XDocumentActMood (2.0.0) (required)
    Fixed Value: EVN
    ... @negationInd 0..1 bl
    ... id 1..* II
    ... code 1..1 CD Binding: v3 Code System ActCode (example)
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: CONC
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 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 SHOULD reference the portion of section narrative text corresponding to this entry
    .... @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 C 0..1 TEL Constraints: value-starts-octothorpe
    .... thumbnail 0..1 ED
    ... statusCode 1..1 CS Binding: ActStatus (required)
    .... @code 1..1 cs Binding: ProblemAct statusCode . (required)
    .... @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 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 0..1 IVXB_TS Required if statusCode = 'active'
    .... center 0..1 TS
    .... width 0..1 PQ
    .... high 0..1 IVXB_TS Required if statusCode = 'completed'
    ... 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..* AuthorParticipation
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... Slices for entryRelationship 1..* EntryRelationship Slice: Unordered, Open by profile:observation
    .... entryRelationship:allergyObs 1..1 EntryRelationship
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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 cs Binding: x_ActRelationshipEntryRelationship (required)
    Fixed Value: SUBJ
    ..... @inversionInd 0..1 bl
    ..... @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 1..1 AllergyIntoleranceObservation
    ..... 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

    Path Status Usage ValueSet Version Source
    Act.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.templateId:allergy-concern-act.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.classCode Base required x_ActClassDocumentEntryAct 📍2.0.0 THO v5.2
    Act.moodCode Base required x_DocumentActMood 📍2.0.0 THO v5.2
    Act.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
    Act.code.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Act.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Act.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Act.statusCode.code Base required ProblemAct statusCode . 📦20240606 VSAC v0.23
    Act.effectiveTime.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.effectiveTime.operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Act.languageCode Base required All Languages 📦5.0.0 FHIR Std.
    Act.entryRelationship:allergyObs.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.entryRelationship:allergyObs.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Act.entryRelationship:allergyObs.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    1198-7504 error Act If statusCode/@code="active" Active, then effectiveTime **SHALL** contain [1..1] low (CONF:1198-7504). (statusCode.code = 'active') implies effectiveTime.low.exists()
    1198-10085 error Act If statusCode/@code="completed" Completed, then effectiveTime **SHALL** contain [1..1] high (CONF:1198-10085). (statusCode.code = 'completed') implies effectiveTime.high.exists()
    II-1 error Act.typeId, Act.entryRelationship:allergyObs.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-author warning Act SHOULD contain author author.exists()
    should-text-ref-value warning Act SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Act.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    This structure is derived from Act

    Summary

    Mandatory: 13 elements
    Fixed: 3 elements
    Prohibited: 1 element

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

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

     

    Other representations of profile: CSV, Excel