Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 Ballot 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-ballot 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: Precondition for Substance Administration

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PreconditionforSubstanceAdministration Version: 4.0.0-ballot
Draft as of 2024-12-19 Computable Name: PreconditionforSubstanceAdministration
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09

A criterion for administration can be used to record that the medication is to be administered only when the associated criteria are met.

Usage:

Formal Views of Template Content

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

This structure is derived from Criterion

NameFlagsCard.TypeDescription & Constraintsdoco
.. Criterion Criterion XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, code, text, value
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:precondition-substance-admin 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.25
..... @extension 1..1 st Required Pattern: 2014-06-09
... code 1..1 CD
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
... value 1..1 CD Binding: US Core Condition Codes (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Criterion.valuerequiredUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
NameFlagsCard.TypeDescription & Constraintsdoco
.. Criterion 1..1 Criterion XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, code, text, value
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 C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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:precondition-substance-admin 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.25
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 0..1 cs Binding: CDAActClassObservation (required)
... @moodCode 0..1 cs Binding: ActMoodPredicate (required)
Fixed Value: EVN.CRT
... code 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
.... @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
... value 1..1 CD Binding: US Core Condition Codes (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Criterion.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.templateId:precondition-substance-admin.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.classCoderequiredCDAActClassObservation
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Criterion.moodCoderequiredFixed Value: EVN.CRT
http://terminology.hl7.org/ValueSet/v3-ActMoodPredicate
Criterion.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Criterion.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.valuerequiredUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
II-1errorCriterion.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Criterion 1..1 Criterion XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, code, text, value
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 C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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:precondition-substance-admin 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.25
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 0..1 cs Binding: CDAActClassObservation (required)
... @moodCode 0..1 cs Binding: ActMoodPredicate (required)
Fixed Value: EVN.CRT
... code 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
.... @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
... value 1..1 CD Binding: US Core Condition Codes (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Criterion.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.templateId:precondition-substance-admin.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.classCoderequiredCDAActClassObservation
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Criterion.moodCoderequiredFixed Value: EVN.CRT
http://terminology.hl7.org/ValueSet/v3-ActMoodPredicate
Criterion.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Criterion.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.valuerequiredUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
II-1errorCriterion.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from Criterion

Summary

Mandatory: 8 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Criterion.templateId

Differential View

This structure is derived from Criterion

NameFlagsCard.TypeDescription & Constraintsdoco
.. Criterion Criterion XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, code, text, value
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:precondition-substance-admin 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.25
..... @extension 1..1 st Required Pattern: 2014-06-09
... code 1..1 CD
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
... value 1..1 CD Binding: US Core Condition Codes (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Criterion.valuerequiredUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Criterion 1..1 Criterion XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, code, text, value
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 C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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:precondition-substance-admin 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.25
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 0..1 cs Binding: CDAActClassObservation (required)
... @moodCode 0..1 cs Binding: ActMoodPredicate (required)
Fixed Value: EVN.CRT
... code 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
.... @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
... value 1..1 CD Binding: US Core Condition Codes (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Criterion.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.templateId:precondition-substance-admin.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.classCoderequiredCDAActClassObservation
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Criterion.moodCoderequiredFixed Value: EVN.CRT
http://terminology.hl7.org/ValueSet/v3-ActMoodPredicate
Criterion.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Criterion.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.valuerequiredUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
II-1errorCriterion.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Criterion 1..1 Criterion XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, code, text, value
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 C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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:precondition-substance-admin 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.25
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 0..1 cs Binding: CDAActClassObservation (required)
... @moodCode 0..1 cs Binding: ActMoodPredicate (required)
Fixed Value: EVN.CRT
... code 1..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Required Pattern: ASSERTION
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.5.4
.... @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
... value 1..1 CD Binding: US Core Condition Codes (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Criterion.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.templateId:precondition-substance-admin.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.classCoderequiredCDAActClassObservation
http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation
Criterion.moodCoderequiredFixed Value: EVN.CRT
http://terminology.hl7.org/ValueSet/v3-ActMoodPredicate
Criterion.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Criterion.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Criterion.valuerequiredUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
II-1errorCriterion.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from Criterion

Summary

Mandatory: 8 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Criterion.templateId

 

Other representations of profile: CSV, Excel