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

FHIR IG Statistics: StructureDefinition/CO

Packageau.digitalhealth.cda.schema
TypeStructureDefinition
IdCO
FHIR VersionR5
Sourcehttp://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-CO.html
URLhttp://hl7.org/cda/stds/core/StructureDefinition/CO
Version1.0.0
Statusactive
Date2025-07-21T22:05:27+00:00
NameCO
TitleCO: CodedOrdinal (V3 Data Type)
Realmau
Authoritynational
DescriptionCoded data, where the coding system from which the code comes is ordered
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CO
Kindlogical

Resources that use this resource

StructureDefinition
ObservationObservation (CDA Class)
ObservationRangeObservationRange (CDA Class)
au-ObservationADHA Observation (CDA Class)
au-ObservationRangeADHA ObservationRange (CDA Class)

Resources that this resource uses

StructureDefinition
CVCV: CodedValue (V3 Data Type)

Narrative

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

Coded data, where the domain from which the codeset comes is ordered. The Coded Ordinal data type adds semantics related to ordering so that models that make use of such domains may introduce model elements that involve statements about the order of the terms in a domain.


Source

{
  "resourceType": "StructureDefinition",
  "id": "CO",
  "text": {
    "status": "generated",
    "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/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-bind"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-binding-style",
      "valueCode": "CDA"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    }
  ],
  "url": "http://hl7.org/cda/stds/core/StructureDefinition/CO",
  "version": "1.0.0",
  "name": "CO",
  "title": "CO: CodedOrdinal (V3 Data Type)",
  "status": "active",
  "experimental": false,
  "date": "2025-07-21T22:05:27+00:00",
  "publisher": "HL7",
  "description": "Coded data, where the coding system from which the code comes is ordered",
  "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/CO",
  "baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/CV",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "1.0.0"
      }
    ],
    "element": [
      {
        "id": "CO",
        "path": "CO",
        "short": "Base for all types and resources",
        "definition": "Coded data, where the domain from which the codeset comes is ordered. The Coded Ordinal data type adds semantics related to ordering so that models that make use of such domains may introduce model elements that involve statements about the order of the terms in a domain.",
        "min": 1,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "CO.nullFlavor",
        "path": "CO.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": "CO.code",
        "path": "CO.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.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "CD.code",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ]
      },
      {
        "id": "CO.codeSystem",
        "path": "CO.codeSystem",
        "representation": [
          "xmlAttr"
        ],
        "label": "Code System",
        "definition": "Specifies the code system that defines the code.",
        "min": 0,
        "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"
            ]
          }
        ]
      },
      {
        "id": "CO.codeSystemName",
        "path": "CO.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": "CO.codeSystemVersion",
        "path": "CO.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": "CO.displayName",
        "path": "CO.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": "CO.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": "CO.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": "CO.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": "CO.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": "CO.originalText",
        "path": "CO.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": "CO.qualifier",
        "path": "CO.qualifier",
        "label": "Qualifier",
        "definition": "Specifies additional codes that increase the specificity of the the primary code.",
        "min": 0,
        "max": "0",
        "base": {
          "path": "CD.qualifier",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
          }
        ]
      },
      {
        "id": "CO.translation",
        "path": "CO.translation",
        "representation": [
          "typeAttr"
        ],
        "label": "Translation",
        "definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
        "min": 0,
        "max": "0",
        "base": {
          "path": "CD.translation",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "CO",
        "path": "CO",
        "definition": "Coded data, where the domain from which the codeset comes is ordered. The Coded Ordinal data type adds semantics related to ordering so that models that make use of such domains may introduce model elements that involve statements about the order of the terms in a domain.",
        "min": 1,
        "max": "*"
      }
    ]
  }
}