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

FHIR IG Statistics: StructureDefinition/Criterion

Packageau.digitalhealth.cda.schema
TypeStructureDefinition
IdCriterion
FHIR VersionR5
Sourcehttp://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-Criterion.html
URLhttp://hl7.org/cda/stds/core/StructureDefinition/Criterion
Version1.0.0
Statusactive
Date2025-07-21T22:05:27+00:00
NameCriterion
TitleCriterion (CDA Class)
Realmau
Authoritynational
DescriptionCriterion (CDA Class)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Criterion
Kindlogical

Resources that use this resource

StructureDefinition
ObservationRangeObservationRange (CDA Class)
PreconditionPrecondition (CDA Class)
Precondition2Precondition2 (CDA Class)
au-PreconditionADHA Precondition (CDA Class)
ImmunizationActivityImmunization Activity
MedicationActivityMedication Activity
PlannedImmunizationActivityPlanned Immunization Activity
PlannedMedicationActivityPlanned Medication Activity
PreconditionforSubstanceAdministrationPrecondition for Substance Administration

Resources that this resource uses

StructureDefinition
ADAD: PostalAddress (V3 Data Type)
BLBL: Boolean (V3 Data Type)
CDCD: ConceptDescriptor (V3 Data Type)
CECE: CodedWithEquivalents (V3 Data Type)
CVCV: CodedValue (V3 Data Type)
EDED: EncapsulatedData (V3 Data Type)
EIVL-TSEIVL_TS: EventRelatedPeriodicInterval (V3 Data Type)
ENEN: EntityName (V3 Data Type)
IIII: InstanceIdentifier (V3 Data Type)
INTINT: IntegerNumber (V3 Data Type)
IVL-PQIVL_PQ: Interval (V3 Data Type)
IVL-TSIVL_TS: Interval (V3 Data Type)
InfrastructureRootInfrastructureRoot (Base Type for all CDA Classes)
MOMO: MonetaryAmount (V3 Data Type)
PIVL-TSPIVL_TS: PeriodicIntervalOfTime (V3 Data Type)
PQPQ: PhysicalQuantity (V3 Data Type)
REALREAL: RealNumber (V3 Data Type)
SCSC: CharacterStringWithCode (V3 Data Type)
STST: CharacterString (V3 Data Type)
SXPR-TSSXPR_TS: Component part of GTS (V3 Data Type)
TELTEL: TelecommunicationAddress (V3 Data Type)
TSTS: PointInTime (V3 Data Type)
cs-simplecs: Coded Simple Value
ValueSet
CDAActClassObservationCDAActClassObservation
v3-ActCodev3 Code System ActCode
v3-ActMoodPredicateActMoodPredicate
v3-ActCodev3 Code System ActCode
v3-ActMoodPredicateActMoodPredicate

Narrative

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

Generated Narrative: StructureDefinition Criterion

NameFlagsCard.TypeDescription & Constraintsdoco
.. Criterion 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1csBinding: CDAActClassObservation (required)
... @moodCode 0..1csBinding: ActMoodPredicate (required)
Fixed Value: EVN.CRT
... code 0..1CDBinding: v3 Code System ActCode (example)
... text 0..1ED
... value 0..1
.... valueBL
.... valueED
.... valueST
.... valueCD
.... valueCV
.... valueCE
.... valueSC
.... valueII
.... valueTEL
.... valueAD
.... valueEN
.... valueINT
.... valueREAL
.... valuePQ
.... valueMO
.... valueTS
.... valueIVL_PQ
.... valueIVL_TS
.... valuePIVL_TS
.... valueEIVL_TS
.... valueSXPR_TS

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "Criterion",
  "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/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://ns.electronichealth.net.au/cda/ImplementationGuide/au.digitalhealth.cda.schema"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/cda/stds/core/StructureDefinition/Criterion",
  "version": "1.0.0",
  "name": "Criterion",
  "title": "Criterion (CDA Class)",
  "status": "active",
  "experimental": false,
  "date": "2025-07-21T22:05:27+00:00",
  "publisher": "HL7",
  "description": "Criterion (CDA Class)",
  "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/InfrastructureRoot",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "1.0.0"
      }
    ],
    "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",
        "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": "InfrastructureRoot.templateId",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "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",
        "min": 0,
        "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.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"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Criterion.value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ST"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CV"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/SC"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/AD"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/EN"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/REAL"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/MO"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Criterion",
        "path": "Criterion",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Criterion.classCode",
        "path": "Criterion.classCode",
        "representation": [
          "xmlAttr"
        ],
        "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",
        "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",
        "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.text",
        "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"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ST"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CV"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/SC"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/AD"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/EN"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/REAL"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/MO"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"
          },
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"
          }
        ]
      }
    ]
  }
}