FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/2.16.840.1.113883.10.20.22.4.25

Packagehl7.cda.us.ccdar2dot2
TypeStructureDefinition
Id2.16.840.1.113883.10.20.22.4.25
FHIR VersionR4
Sourcehttp://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda-2.2/StructureDefinition-2.16.840.1.113883.10.20.22.4.25.html
URLhttp://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.25
Version2.2
Statusactive
Date2022-05-13T15:50:12+00:00
NamePreconditionforSubstanceAdministration
TitlePrecondition for Substance Administration
Realmus
Authorityhl7
DescriptionA criterion for administration can be used to record that the medication is to be administered only when the associated criteria are met.
TypeCriterion
Kindresource

Resources that use this resource

StructureDefinition
2.16.840.1.113883.10.20.22.4.120Planned Immunization Activity
2.16.840.1.113883.10.20.22.4.16Medication Activity
2.16.840.1.113883.10.20.22.4.42Planned Medication Activity
2.16.840.1.113883.10.20.22.4.52Immunization Activity

Resources that this resource uses

ValueSet
2.16.840.1.113883.3.88.12.3221.7.4Problem

Narrative

Note: links and images are rebased to the (stated) source

NameFlagsCard.TypeDescription & Constraintsdoco
.. Criterion 1..1CDAR2.Criterion
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.25
..... extension 1..1stringRequired Pattern: 2014-06-09
... code 1..1CD
.... code 1..1stringRequired Pattern: ASSERTION
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.5.4
... value 1..1CDBinding: Problem (required)

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "2.16.840.1.113883.10.20.22.4.25",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.25",
  "identifier": [
    {
      "value": "urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09"
    }
  ],
  "version": "2.2",
  "name": "PreconditionforSubstanceAdministration",
  "title": "Precondition for Substance Administration",
  "status": "active",
  "date": "2022-05-13T15:50:12+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": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Criterion",
  "baseDefinition": "http://hl7.org/fhir/cda/StructureDefinition/Criterion",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "id": "Criterion",
        "path": "Criterion",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false
      },
      {
        "id": "Criterion.classCode",
        "path": "Criterion.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 1,
        "max": "1",
        "base": {
          "path": "Criterion.classCode",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "defaultValueCode": "OBS",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClassObservation"
        }
      },
      {
        "id": "Criterion.moodCode",
        "path": "Criterion.moodCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 1,
        "max": "1",
        "base": {
          "path": "Criterion.moodCode",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "defaultValueCode": "EVN.CRT",
        "fixedCode": "EVN.CRT",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActMoodPredicate"
        }
      },
      {
        "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": 0,
        "max": "*",
        "base": {
          "path": "Criterion.templateId",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "Criterion.templateId:primary",
        "path": "Criterion.templateId",
        "sliceName": "primary",
        "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",
        "requirements": "SHALL contain exactly one [1..1] templateId (CONF:1098-7372) such that it",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Criterion.templateId",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/fhir/cda/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "Criterion.templateId:primary.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"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
        }
      },
      {
        "id": "Criterion.templateId:primary.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"
          }
        ]
      },
      {
        "id": "Criterion.templateId:primary.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"
          }
        ]
      },
      {
        "id": "Criterion.templateId:primary.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.",
        "requirements": "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.22.4.25\" (CONF:1098-10517).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "II.root",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "patternString": "2.16.840.1.113883.10.20.22.4.25"
      },
      {
        "id": "Criterion.templateId:primary.extension",
        "path": "Criterion.templateId.extension",
        "representation": [
          "xmlAttr"
        ],
        "label": "Extension",
        "definition": "A character string as a unique identifier within the scope of the identifier root.",
        "requirements": "SHALL contain exactly one [1..1] @extension=\"2014-06-09\" (CONF:1098-32603).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "II.extension",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "patternString": "2014-06-09"
      },
      {
        "id": "Criterion.code",
        "path": "Criterion.code",
        "requirements": "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/fhir/cda/StructureDefinition/CD"
          }
        ],
        "binding": {
          "strength": "extensible",
          "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"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
        }
      },
      {
        "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.",
        "requirements": "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": "string"
          }
        ],
        "patternString": "ASSERTION"
      },
      {
        "id": "Criterion.code.codeSystem",
        "path": "Criterion.code.codeSystem",
        "representation": [
          "xmlAttr"
        ],
        "label": "Code System",
        "definition": "Specifies the code system that defines the code.",
        "requirements": "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"
          }
        ],
        "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"
          }
        ]
      },
      {
        "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"
          }
        ]
      },
      {
        "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"
          }
        ]
      },
      {
        "id": "Criterion.code.sdtcValueSet",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-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"
          }
        ]
      },
      {
        "id": "Criterion.code.sdtcValueSetVersion",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
            "valueUri": "urn:hl7-org:sdtc"
          },
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-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"
          }
        ]
      },
      {
        "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/fhir/cda/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/fhir/cda/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/fhir/cda/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/fhir/cda/StructureDefinition/ED"
          }
        ]
      },
      {
        "id": "Criterion.value",
        "path": "Criterion.value",
        "representation": [
          "typeAttr"
        ],
        "requirements": "SHALL contain exactly one [1..1] value with @xsi:type=\"CD\", where the code SHALL be selected from ValueSet Problem urn:oid:2.16.840.1.113883.3.88.12.3221.7.4 DYNAMIC (CONF:1098-7369).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Criterion.value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/fhir/cda/StructureDefinition/CD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.7.4"
        }
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Criterion",
        "path": "Criterion"
      },
      {
        "id": "Criterion.templateId",
        "path": "Criterion.templateId",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "root"
            },
            {
              "type": "value",
              "path": "extension"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Criterion.templateId:primary",
        "path": "Criterion.templateId",
        "sliceName": "primary",
        "requirements": "SHALL contain exactly one [1..1] templateId (CONF:1098-7372) such that it",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Criterion.templateId:primary.root",
        "path": "Criterion.templateId.root",
        "requirements": "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.22.4.25\" (CONF:1098-10517).",
        "min": 1,
        "max": "1",
        "patternString": "2.16.840.1.113883.10.20.22.4.25"
      },
      {
        "id": "Criterion.templateId:primary.extension",
        "path": "Criterion.templateId.extension",
        "requirements": "SHALL contain exactly one [1..1] @extension=\"2014-06-09\" (CONF:1098-32603).",
        "min": 1,
        "max": "1",
        "patternString": "2014-06-09"
      },
      {
        "id": "Criterion.code",
        "path": "Criterion.code",
        "requirements": "SHALL contain exactly one [1..1] code with @xsi:type=\"CD\" (CONF:1098-32396).",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Criterion.code.code",
        "path": "Criterion.code.code",
        "requirements": "This code SHALL contain exactly one [1..1] @code=\"ASSERTION\" Assertion (CONF:1098-32397).",
        "min": 1,
        "max": "1",
        "patternString": "ASSERTION"
      },
      {
        "id": "Criterion.code.codeSystem",
        "path": "Criterion.code.codeSystem",
        "requirements": "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",
        "patternString": "2.16.840.1.113883.5.4"
      },
      {
        "id": "Criterion.value",
        "path": "Criterion.value",
        "requirements": "SHALL contain exactly one [1..1] value with @xsi:type=\"CD\", where the code SHALL be selected from ValueSet Problem urn:oid:2.16.840.1.113883.3.88.12.3221.7.4 DYNAMIC (CONF:1098-7369).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/fhir/cda/StructureDefinition/CD"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.7.4"
        }
      }
    ]
  }
}