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

FHIR IG Statistics: StructureDefinition/au-Material

Packageau.digitalhealth.cda.schema
TypeStructureDefinition
Idau-Material
FHIR VersionR5
Sourcehttp://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-au-Material.html
URLhttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Material
Version1.0.0
Statusactive
Date2025-07-21T22:05:27+00:00
Nameau-Material
TitleADHA Material (CDA Class)
Realmau
Authoritynational
Description**Australian adaptation of the [HL7 International CDA Material class]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Material.html)**. This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA
CopyrightCopyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/).
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Material
Kindlogical

Resources that use this resource

StructureDefinition
au-ManufacturedProductADHA ManufacturedProduct (CDA Class)

Resources that this resource uses

StructureDefinition
CDCD: ConceptDescriptor (V3 Data Type)
CECE: CodedWithEquivalents (V3 Data Type)
ENEN: EntityName (V3 Data Type)
InfrastructureRootInfrastructureRoot (Base Type for all CDA Classes)
STST: CharacterString (V3 Data Type)
TSTS: PointInTime (V3 Data Type)
asIngredientADHA extension asIngredient
cs-simplecs: Coded Simple Value
ValueSet
CDAMaterialEntityClassTypeCDAMaterialEntityClassType
v3-EntityClassManufacturedMaterialEntityClassManufacturedMaterial
v3-EntityDeterminerDeterminedEntityDeterminerDetermined
v3-EntityClassManufacturedMaterialEntityClassManufacturedMaterial
v3-EntityDeterminerDeterminedEntityDeterminerDetermined

Narrative

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

A subtype of Entity that is inanimate and locationally independent.

Materials are entities that are neither Living Subjects nor places. Manufactured or processed products are considered material, even if they originate as living matter. Materials come in a wide variety of physical forms and can pass through different states (ie. Gas, liquid, solid) while still retaining their physical composition and material characteristics.

Clarify the meaning of "locationally independent"; suggest removing it and supplanting with first Usage Note sentence.

Pharmaceutical substances (including active vaccines containing retarded virus), disposable supplies, durable equipment, implantable devices, food items (including meat or plant products), waste, traded goods.


Source

{
  "resourceType": "StructureDefinition",
  "id": "au-Material",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1
    },
    {
      "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/logical-container",
      "valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
      "valueUri": "urn:hl7-org:v3"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
      "valueString": "manufacturedMaterial"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
      "valueCode": "cda"
    }
  ],
  "url": "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Material",
  "version": "1.0.0",
  "name": "au-Material",
  "title": "ADHA Material (CDA Class)",
  "status": "active",
  "experimental": false,
  "date": "2025-07-21T22:05:27+00:00",
  "publisher": "Australian Digital Health Agency",
  "contact": [
    {
      "name": "Australian Digital Health Agency",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:help@digitalhealth.gov.au"
        }
      ]
    }
  ],
  "description": "**Australian adaptation of the [HL7 International CDA Material class](     https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Material.html)**.     \n\nThis is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "AU"
        }
      ]
    }
  ],
  "copyright": "Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/).",
  "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/Material",
  "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": "Material",
        "path": "Material",
        "short": "Australian adaptation of the HL7 International CDA Material class",
        "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": "Material.nullFlavor",
        "path": "Material.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": "Material.realmCode",
        "path": "Material.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": "Material.typeId",
        "path": "Material.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": "Material.typeId.nullFlavor",
        "path": "Material.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": "Material.typeId.assigningAuthorityName",
        "path": "Material.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": "Material.typeId.displayable",
        "path": "Material.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": "Material.typeId.root",
        "path": "Material.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": "Material.typeId.extension",
        "path": "Material.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": "Material.templateId",
        "path": "Material.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": "Material.classCode",
        "path": "Material.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Material.classCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "MMAT",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial"
        }
      },
      {
        "id": "Material.determinerCode",
        "path": "Material.determinerCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "Material.determinerCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "KIND",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined"
        }
      },
      {
        "id": "Material.code",
        "path": "Material.code",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Material.code",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAMaterialEntityClassType"
        }
      },
      {
        "id": "Material.name",
        "path": "Material.name",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Material.name",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/EN"
          }
        ]
      },
      {
        "id": "Material.desc",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "Material.desc",
        "short": "ADHA CDA extension to represent material's description",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Material.desc",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/ST"
            ]
          }
        ]
      },
      {
        "id": "Material.lotNumberText",
        "path": "Material.lotNumberText",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Material.lotNumberText",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ST"
          }
        ]
      },
      {
        "id": "Material.expirationTime",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "Material.expirationTime",
        "short": "ADHA CDA extension to represent material's expiration time",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Material.expirationTime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/TS"
            ]
          }
        ]
      },
      {
        "id": "Material.asIngredient",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "Material.asIngredient",
        "short": "ADHA CDA extension to represent material's ingredient",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Material.asIngredient",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/asIngredient",
            "profile": [
              "http://ns.electronichealth.net.au/cda/StructureDefinition/asIngredient"
            ]
          }
        ]
      },
      {
        "id": "Material.formCode",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "Material.formCode",
        "short": "ADHA CDA extension to represent material's form code",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Material.formCode",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/CD"
            ]
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Material",
        "path": "Material",
        "short": "Australian adaptation of the HL7 International CDA Material class",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Material.classCode",
        "path": "Material.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "MMAT",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial"
        }
      },
      {
        "id": "Material.determinerCode",
        "path": "Material.determinerCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "KIND",
        "binding": {
          "strength": "required",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined"
        }
      },
      {
        "id": "Material.code",
        "path": "Material.code",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAMaterialEntityClassType"
        }
      },
      {
        "id": "Material.name",
        "path": "Material.name",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/EN"
          }
        ]
      },
      {
        "id": "Material.desc",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "Material.desc",
        "short": "ADHA CDA extension to represent material's description",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ST",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/ST"
            ]
          }
        ]
      },
      {
        "id": "Material.lotNumberText",
        "path": "Material.lotNumberText",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ST"
          }
        ]
      },
      {
        "id": "Material.expirationTime",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "Material.expirationTime",
        "short": "ADHA CDA extension to represent material's expiration time",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/TS",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/TS"
            ]
          }
        ]
      },
      {
        "id": "Material.asIngredient",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "Material.asIngredient",
        "short": "ADHA CDA extension to represent material's ingredient",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/asIngredient",
            "profile": [
              "http://ns.electronichealth.net.au/cda/StructureDefinition/asIngredient"
            ]
          }
        ]
      },
      {
        "id": "Material.formCode",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "Material.formCode",
        "short": "ADHA CDA extension to represent material's form code",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/CD"
            ]
          }
        ]
      }
    ]
  }
}