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

FHIR IG Statistics: StructureDefinition/entitlement

Packageau.digitalhealth.cda.schema
TypeStructureDefinition
Identitlement
FHIR VersionR5
Sourcehttp://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-entitlement.html
URLhttp://ns.electronichealth.net.au/cda/StructureDefinition/entitlement
Version1.0.0
Statusactive
Date2025-07-21T22:05:27+00:00
Nameentitlement
TitleADHA extension entitlement
Realmau
Authoritynational
DescriptionThe entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context.
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://ns.electronichealth.net.au/cda/StructureDefinition/entitlement
Kindlogical

Resources that use this resource

StructureDefinition
coverage2ADHA extension coverage2

Resources that this resource uses

StructureDefinition
CECE: CodedWithEquivalents (V3 Data Type)
IIII: InstanceIdentifier (V3 Data Type)
IVL-TSIVL_TS: Interval (V3 Data Type)
InfrastructureRootInfrastructureRoot (Base Type for all CDA Classes)
cs-simplecs: Coded Simple Value
participantADHA extension participant
templateIdtemplateId

Narrative

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

Generated Narrative: StructureDefinition entitlement

NameFlagsCard.TypeDescription & Constraintsdoco
.. entitlement 1..*InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
ADHA CDA extension to represent entitlement
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 1..1csFixed Value: COV
... @moodCode 1..1csFixed Value: EVN
... templateId 0..*IIXML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent entitlement templateId
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... id 1..1IIXML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent entitlement id
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... code 1..1CEXML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent entitlement scope
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... effectiveTime 0..1IVL_TSXML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent entitlement time
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
... participant 0..*participantXML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
ADHA CDA extension to represent the participant
XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "entitlement",
  "text": {
    "status": "extensions",
    "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/StructureDefinition/elementdefinition-namespace",
      "valueUri": "urn:hl7-org:v3"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
      "valueUri": "urn:hl7-org:v3"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
      "valueString": "infrastructureRoot"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
      "valueCode": "cda"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    }
  ],
  "url": "http://ns.electronichealth.net.au/cda/StructureDefinition/entitlement",
  "version": "1.0.0",
  "name": "entitlement",
  "title": "ADHA extension entitlement",
  "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": "The entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context.",
  "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://ns.electronichealth.net.au/cda/StructureDefinition/entitlement",
  "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": "entitlement",
        "path": "entitlement",
        "short": "ADHA CDA extension to represent entitlement",
        "definition": "The entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context.",
        "min": 1,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "entitlement.nullFlavor",
        "path": "entitlement.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": "entitlement.realmCode",
        "path": "entitlement.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": "entitlement.typeId",
        "path": "entitlement.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": "entitlement.typeId.nullFlavor",
        "path": "entitlement.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": "entitlement.typeId.assigningAuthorityName",
        "path": "entitlement.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": "entitlement.typeId.displayable",
        "path": "entitlement.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": "entitlement.typeId.root",
        "path": "entitlement.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": "entitlement.typeId.extension",
        "path": "entitlement.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": "entitlement.templateId",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "entitlement.templateId",
        "short": "ADHA CDA extension to represent entitlement templateId",
        "definition": "A number or code issued for the purpose of identifying the entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "InfrastructureRoot.templateId",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/templateId"
          }
        ]
      },
      {
        "id": "entitlement.classCode",
        "path": "entitlement.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 1,
        "max": "1",
        "base": {
          "path": "entitlement.classCode",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "COV"
      },
      {
        "id": "entitlement.moodCode",
        "path": "entitlement.moodCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 1,
        "max": "1",
        "base": {
          "path": "entitlement.moodCode",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "EVN"
      },
      {
        "id": "entitlement.id",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "entitlement.id",
        "short": "ADHA CDA extension to represent entitlement id",
        "definition": "A number or code issued for the purpose of identifying the entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "entitlement.id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "entitlement.code",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "entitlement.code",
        "short": "ADHA CDA extension to represent entitlement scope",
        "definition": "he description of the scope of an entitlement.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "entitlement.code",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ]
      },
      {
        "id": "entitlement.effectiveTime",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "entitlement.effectiveTime",
        "short": "ADHA CDA extension to represent entitlement time",
        "definition": "The time interval for which an entitlement is valid.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "entitlement.effectiveTime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id": "entitlement.participant",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "entitlement.participant",
        "short": "ADHA CDA extension to represent the participant",
        "min": 0,
        "max": "*",
        "base": {
          "path": "entitlement.participant",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/participant"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "entitlement",
        "path": "entitlement",
        "short": "ADHA CDA extension to represent entitlement",
        "definition": "The entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context.",
        "min": 1,
        "max": "*"
      },
      {
        "id": "entitlement.classCode",
        "path": "entitlement.classCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "COV"
      },
      {
        "id": "entitlement.moodCode",
        "path": "entitlement.moodCode",
        "representation": [
          "xmlAttr"
        ],
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "fixedCode": "EVN"
      },
      {
        "id": "entitlement.templateId",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "entitlement.templateId",
        "short": "ADHA CDA extension to represent entitlement templateId",
        "definition": "A number or code issued for the purpose of identifying the entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/templateId"
          }
        ]
      },
      {
        "id": "entitlement.id",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "entitlement.id",
        "short": "ADHA CDA extension to represent entitlement id",
        "definition": "A number or code issued for the purpose of identifying the entitlement or right of a participant to act in a given capacity (as defined by Entitlement Type) within a healthcare context.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
          }
        ]
      },
      {
        "id": "entitlement.code",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "entitlement.code",
        "short": "ADHA CDA extension to represent entitlement scope",
        "definition": "he description of the scope of an entitlement.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
          }
        ]
      },
      {
        "id": "entitlement.effectiveTime",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "entitlement.effectiveTime",
        "short": "ADHA CDA extension to represent entitlement time",
        "definition": "The time interval for which an entitlement is valid.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id": "entitlement.participant",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
            "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"
          }
        ],
        "path": "entitlement.participant",
        "short": "ADHA CDA extension to represent the participant",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/participant"
          }
        ]
      }
    ]
  }
}