Package | hl7.cda.us.ccda |
Type | StructureDefinition |
Id | PreconditionforSubstanceAdministration |
FHIR Version | R5 |
Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda/StructureDefinition-PreconditionforSubstanceAdministration.html |
URL | http://hl7.org/cda/us/ccda/StructureDefinition/PreconditionforSubstanceAdministration |
Version | 4.0.0 |
Status | draft |
Date | 2025-06-26T21:09:45+00:00 |
Name | PreconditionforSubstanceAdministration |
Title | Precondition for Substance Administration |
Realm | us |
Authority | hl7 |
Description | A criterion for administration can be used to record that the medication is to be administered only when the associated criteria are met. |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Criterion |
Kind | logical |
StructureDefinition | |
ImmunizationActivity | Immunization Activity |
MedicationActivity | Medication Activity |
PlannedImmunizationActivity | Planned Immunization Activity |
PlannedMedicationActivity | Planned Medication Activity |
StructureDefinition | |
CD | CD: ConceptDescriptor (V3 Data Type) |
Criterion | Criterion (CDA Class) |
ValueSet | |
us-core-condition-code | US Core Condition Codes |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition PreconditionforSubstanceAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
![]() ![]() | 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) | ||
![]() ![]() ![]() | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | 1..1 | II | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.25 | |
![]() ![]() ![]() ![]() ![]() | 1..1 | st | Required Pattern: 2014-06-09 | |
![]() ![]() ![]() | 1..1 | CD | ||
![]() ![]() ![]() ![]() | 1..1 | cs | Required Pattern: ASSERTION | |
![]() ![]() ![]() ![]() | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.4 | |
![]() ![]() ![]() | 1..1 | CD | Binding: US Core Condition Codes (required) | |
{ "resourceType": "StructureDefinition", "id": "PreconditionforSubstanceAdministration", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target", "_valueBoolean": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode": "not-applicable" } ] } }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace", "valueUri": "urn:hl7-org:v3" }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name", "valueString": "criterion" }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container", "valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument" }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style", "valueCode": "cda" } ], "url": "http://hl7.org/cda/us/ccda/StructureDefinition/PreconditionforSubstanceAdministration", "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09" } ], "version": "4.0.0", "name": "PreconditionforSubstanceAdministration", "title": "Precondition for Substance Administration", "status": "draft", "date": "2025-06-26T21:09:45+00:00", "publisher": "Health Level Seven", "contact": [ { "name": "HL7 International - Structured Documents", "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/structure" } ] } ], "description": "A criterion for administration can be used to record that the medication is to be administered only when the associated criteria are met.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US" } ] } ], "fhirVersion": "5.0.0", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "logical", "abstract": false, "type": "http://hl7.org/cda/stds/core/StructureDefinition/Criterion", "baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/Criterion", "derivation": "constraint", "snapshot": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "2.0.1-sd" } ], "element": [ { "id": "Criterion", "path": "Criterion", "short": "Base for all types and resources", "definition": "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.", "min": 1, "max": "1", "base": { "path": "Base", "min": 0, "max": "*" }, "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Criterion.nullFlavor", "path": "Criterion.nullFlavor", "representation": [ "xmlAttr" ], "label": "Exceptional Value Detail", "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min": 0, "max": "1", "base": { "path": "ANY.nullFlavor", "min": 0, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id": "Criterion.realmCode", "path": "Criterion.realmCode", "definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question", "min": 0, "max": "*", "base": { "path": "InfrastructureRoot.realmCode", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CS" } ] }, { "id": "Criterion.typeId", "path": "Criterion.typeId", "definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.", "min": 0, "max": "1", "base": { "path": "InfrastructureRoot.typeId", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ], "constraint": [ { "key": "II-1", "severity": "error", "human": "An II instance must have either a root or an nullFlavor.", "expression": "root.exists() or nullFlavor.exists()", "source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot" } ] }, { "id": "Criterion.typeId.nullFlavor", "path": "Criterion.typeId.nullFlavor", "representation": [ "xmlAttr" ], "label": "Exceptional Value Detail", "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min": 0, "max": "1", "base": { "path": "ANY.nullFlavor", "min": 0, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id": "Criterion.typeId.assigningAuthorityName", "path": "Criterion.typeId.assigningAuthorityName", "representation": [ "xmlAttr" ], "label": "Assigning Authority Name", "definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.", "min": 0, "max": "1", "base": { "path": "II.assigningAuthorityName", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ] } ] }, { "id": "Criterion.typeId.displayable", "path": "Criterion.typeId.displayable", "representation": [ "xmlAttr" ], "label": "Displayable", "definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).", "min": 0, "max": "1", "base": { "path": "II.displayable", "min": 0, "max": "1" }, "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ] }, { "id": "Criterion.typeId.root", "path": "Criterion.typeId.root", "representation": [ "xmlAttr" ], "label": "Root", "definition": "Identifies the type as an HL7 Registered model", "min": 1, "max": "1", "base": { "path": "II.root", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ] } ], "fixedString": "2.16.840.1.113883.1.3" }, { "id": "Criterion.typeId.extension", "path": "Criterion.typeId.extension", "representation": [ "xmlAttr" ], "label": "Extension", "definition": "A character string as a unique identifier within the scope of the identifier root.", "min": 1, "max": "1", "base": { "path": "II.extension", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ] } ] }, { "id": "Criterion.templateId", "path": "Criterion.templateId", "slicing": { "discriminator": [ { "type": "value", "path": "root" }, { "type": "value", "path": "extension" } ], "rules": "open" }, "definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question", "min": 1, "max": "*", "base": { "path": "InfrastructureRoot.templateId", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ] }, { "id": "Criterion.templateId:precondition-substance-admin", "path": "Criterion.templateId", "sliceName": "precondition-substance-admin", "definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question", "min": 1, "max": "1", "base": { "path": "InfrastructureRoot.templateId", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ] }, { "id": "Criterion.templateId:precondition-substance-admin.nullFlavor", "path": "Criterion.templateId.nullFlavor", "representation": [ "xmlAttr" ], "label": "Exceptional Value Detail", "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min": 0, "max": "1", "base": { "path": "ANY.nullFlavor", "min": 0, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id": "Criterion.templateId:precondition-substance-admin.assigningAuthorityName", "path": "Criterion.templateId.assigningAuthorityName", "representation": [ "xmlAttr" ], "label": "Assigning Authority Name", "definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.", "min": 0, "max": "1", "base": { "path": "II.assigningAuthorityName", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ] } ] }, { "id": "Criterion.templateId:precondition-substance-admin.displayable", "path": "Criterion.templateId.displayable", "representation": [ "xmlAttr" ], "label": "Displayable", "definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).", "min": 0, "max": "1", "base": { "path": "II.displayable", "min": 0, "max": "1" }, "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ] }, { "id": "Criterion.templateId:precondition-substance-admin.root", "path": "Criterion.templateId.root", "representation": [ "xmlAttr" ], "label": "Root", "definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.", "min": 1, "max": "1", "base": { "path": "II.root", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ] } ], "patternString": "2.16.840.1.113883.10.20.22.4.25" }, { "id": "Criterion.templateId:precondition-substance-admin.extension", "path": "Criterion.templateId.extension", "representation": [ "xmlAttr" ], "label": "Extension", "definition": "A character string as a unique identifier within the scope of the identifier root.", "min": 1, "max": "1", "base": { "path": "II.extension", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ] } ], "patternString": "2014-06-09" }, { "id": "Criterion.classCode", "path": "Criterion.classCode", "representation": [ "xmlAttr" ], "min": 0, "max": "1", "base": { "path": "Criterion.classCode", "min": 0, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "defaultValueCode": "OBS", "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation" } }, { "id": "Criterion.moodCode", "path": "Criterion.moodCode", "representation": [ "xmlAttr" ], "min": 0, "max": "1", "base": { "path": "Criterion.moodCode", "min": 0, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "fixedCode": "EVN.CRT", "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActMoodPredicate" } }, { "id": "Criterion.code", "path": "Criterion.code", "comment": "SHALL contain exactly one [1..1] code with @xsi:type=\"CD\" (CONF:1098-32396).", "min": 1, "max": "1", "base": { "path": "Criterion.code", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD" } ], "binding": { "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode" } }, { "id": "Criterion.code.nullFlavor", "path": "Criterion.code.nullFlavor", "representation": [ "xmlAttr" ], "label": "Exceptional Value Detail", "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min": 0, "max": "1", "base": { "path": "ANY.nullFlavor", "min": 0, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id": "Criterion.code.code", "path": "Criterion.code.code", "representation": [ "xmlAttr" ], "label": "Code", "definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.", "comment": "This code SHALL contain exactly one [1..1] @code=\"ASSERTION\" Assertion (CONF:1098-32397).", "min": 1, "max": "1", "base": { "path": "CD.code", "min": 0, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "patternCode": "ASSERTION" }, { "id": "Criterion.code.codeSystem", "path": "Criterion.code.codeSystem", "representation": [ "xmlAttr" ], "label": "Code System", "definition": "Specifies the code system that defines the code.", "comment": "This code SHALL contain exactly one [1..1] @codeSystem=\"2.16.840.1.113883.5.4\" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32398).", "min": 1, "max": "1", "base": { "path": "CD.codeSystem", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ] } ], "patternString": "2.16.840.1.113883.5.4" }, { "id": "Criterion.code.codeSystemName", "path": "Criterion.code.codeSystemName", "representation": [ "xmlAttr" ], "label": "Code System Name", "definition": "The common name of the coding system.", "min": 0, "max": "1", "base": { "path": "CD.codeSystemName", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ] } ] }, { "id": "Criterion.code.codeSystemVersion", "path": "Criterion.code.codeSystemVersion", "representation": [ "xmlAttr" ], "label": "Code System Version", "definition": "If applicable, a version descriptor defined specifically for the given code system.", "min": 0, "max": "1", "base": { "path": "CD.codeSystemVersion", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ] } ] }, { "id": "Criterion.code.displayName", "path": "Criterion.code.displayName", "representation": [ "xmlAttr" ], "label": "Display Name", "definition": "A name or title for the code, under which the sending system shows the code value to its users.", "min": 0, "max": "1", "base": { "path": "CD.displayName", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ] } ] }, { "id": "Criterion.code.sdtcValueSet", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace", "valueUri": "urn:hl7-org:sdtc" }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name", "valueString": "valueSet" } ], "path": "Criterion.code.sdtcValueSet", "representation": [ "xmlAttr" ], "definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.", "min": 0, "max": "1", "base": { "path": "CD.valueSet", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ] } ] }, { "id": "Criterion.code.sdtcValueSetVersion", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace", "valueUri": "urn:hl7-org:sdtc" }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name", "valueString": "valueSetVersion" } ], "path": "Criterion.code.sdtcValueSetVersion", "representation": [ "xmlAttr" ], "definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.", "min": 0, "max": "1", "base": { "path": "CD.sdtcValueSetVersion", "min": 0, "max": "1" }, "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ] } ] }, { "id": "Criterion.code.originalText", "path": "Criterion.code.originalText", "label": "Original Text", "definition": "The text or phrase used as the basis for the coding.", "min": 0, "max": "1", "base": { "path": "CD.originalText", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ED" } ] }, { "id": "Criterion.code.qualifier", "path": "Criterion.code.qualifier", "label": "Qualifier", "definition": "Specifies additional codes that increase the specificity of the the primary code.", "min": 0, "max": "*", "base": { "path": "CD.qualifier", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CR" } ] }, { "id": "Criterion.code.translation", "path": "Criterion.code.translation", "representation": [ "typeAttr" ], "label": "Translation", "definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.", "min": 0, "max": "*", "base": { "path": "CD.translation", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD" } ] }, { "id": "Criterion.text", "path": "Criterion.text", "min": 0, "max": "1", "base": { "path": "Criterion.text", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ED" } ] }, { "id": "Criterion.value", "path": "Criterion.value", "representation": [ "typeAttr" ], "comment": "SHALL contain exactly one [1..1] value with @xsi:type=\"CD\", where the code SHALL be selected from ValueSet US Core Condition Codes.", "min": 1, "max": "1", "base": { "path": "Criterion.value", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD" } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code" } } ] }, "differential": { "element": [ { "id": "Criterion.templateId", "path": "Criterion.templateId", "slicing": { "discriminator": [ { "type": "value", "path": "root" }, { "type": "value", "path": "extension" } ], "rules": "open" }, "min": 1 }, { "id": "Criterion.templateId:precondition-substance-admin", "path": "Criterion.templateId", "sliceName": "precondition-substance-admin", "min": 1, "max": "1" }, { "id": "Criterion.templateId:precondition-substance-admin.root", "path": "Criterion.templateId.root", "min": 1, "patternString": "2.16.840.1.113883.10.20.22.4.25" }, { "id": "Criterion.templateId:precondition-substance-admin.extension", "path": "Criterion.templateId.extension", "min": 1, "patternString": "2014-06-09" }, { "id": "Criterion.code", "path": "Criterion.code", "comment": "SHALL contain exactly one [1..1] code with @xsi:type=\"CD\" (CONF:1098-32396).", "min": 1 }, { "id": "Criterion.code.code", "path": "Criterion.code.code", "comment": "This code SHALL contain exactly one [1..1] @code=\"ASSERTION\" Assertion (CONF:1098-32397).", "min": 1, "patternCode": "ASSERTION" }, { "id": "Criterion.code.codeSystem", "path": "Criterion.code.codeSystem", "comment": "This code SHALL contain exactly one [1..1] @codeSystem=\"2.16.840.1.113883.5.4\" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32398).", "min": 1, "patternString": "2.16.840.1.113883.5.4" }, { "id": "Criterion.value", "path": "Criterion.value", "comment": "SHALL contain exactly one [1..1] value with @xsi:type=\"CD\", where the code SHALL be selected from ValueSet US Core Condition Codes.", "min": 1, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD" } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code" } } ] } }