Package | au.digitalhealth.cda.schema |
Type | StructureDefinition |
Id | au-IntendedRecipient |
FHIR Version | R5 |
Source | http://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-au-IntendedRecipient.html |
URL | http://ns.electronichealth.net.au/cda/StructureDefinition/au-IntendedRecipient |
Version | 1.0.0 |
Status | active |
Date | 2025-07-21T22:05:27+00:00 |
Name | au-IntendedRecipient |
Title | ADHA IntendedRecipient (CDA Class) |
Realm | au |
Authority | national |
Description | **Australian adaptation of the [HL7 International CDA IntendedRecipient class]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-IntendedRecipient.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 |
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/). |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IntendedRecipient |
Kind | logical |
StructureDefinition | |
au-InformationRecipient | ADHA InformationRecipient (CDA Class) |
StructureDefinition | |
CD | CD: ConceptDescriptor (V3 Data Type) |
II | II: InstanceIdentifier (V3 Data Type) |
InfrastructureRoot | InfrastructureRoot (Base Type for all CDA Classes) |
au-Address | ADHA AD: PostalAddress (V3 Data Type) |
au-Organization | ADHA Organization (CDA Class) |
au-Person | ADHA Person (CDA Class) |
au-Telecom | ADHA TEL: TelecommunicationAddress (V3 Data Type) |
cs-simple | cs: Coded Simple Value |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition au-IntendedRecipient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
![]() ![]() | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA IntendedRecipient class Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
![]() ![]() ![]() | 0..1 | cs | ||
![]() ![]() ![]() | 0..* | II | ||
![]() ![]() ![]() | 0..1 | CD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent intended recipient's role code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
![]() ![]() ![]() | 0..* | AD | Australian-adapted PostalAddress datatype | |
![]() ![]() ![]() | 0..* | TEL | Australian-adapted TelecommunicationAddress datatype | |
![]() ![]() ![]() | 0..1 | au-Person | Australian-adapted Person class | |
![]() ![]() ![]() | 0..1 | au-Organization | Australian-adapted Organization class | |
{ "resourceType": "StructureDefinition", "id": "au-IntendedRecipient", "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/tools/StructureDefinition/xml-namespace", "valueUri": "urn:hl7-org:v3" }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name", "valueString": "intendedRecipient" }, { "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://ns.electronichealth.net.au/cda/StructureDefinition/au-IntendedRecipient", "version": "1.0.0", "name": "au-IntendedRecipient", "title": "ADHA IntendedRecipient (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 IntendedRecipient class]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-IntendedRecipient.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/IntendedRecipient", "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": "IntendedRecipient", "path": "IntendedRecipient", "short": "Australian adaptation of the HL7 International CDA IntendedRecipient 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": "IntendedRecipient.nullFlavor", "path": "IntendedRecipient.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": "IntendedRecipient.realmCode", "path": "IntendedRecipient.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": "IntendedRecipient.typeId", "path": "IntendedRecipient.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": "IntendedRecipient.typeId.nullFlavor", "path": "IntendedRecipient.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": "IntendedRecipient.typeId.assigningAuthorityName", "path": "IntendedRecipient.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": "IntendedRecipient.typeId.displayable", "path": "IntendedRecipient.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": "IntendedRecipient.typeId.root", "path": "IntendedRecipient.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": "IntendedRecipient.typeId.extension", "path": "IntendedRecipient.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": "IntendedRecipient.templateId", "path": "IntendedRecipient.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": "IntendedRecipient.classCode", "path": "IntendedRecipient.classCode", "representation": [ "xmlAttr" ], "min": 0, "max": "1", "base": { "path": "IntendedRecipient.classCode", "min": 0, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "defaultValueCode": "ASSIGNED" }, { "id": "IntendedRecipient.id", "path": "IntendedRecipient.id", "min": 0, "max": "*", "base": { "path": "IntendedRecipient.id", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ] }, { "id": "IntendedRecipient.code", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace", "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0" } ], "path": "IntendedRecipient.code", "short": "ADHA CDA extension to represent intended recipient's role code", "min": 0, "max": "1", "base": { "path": "IntendedRecipient.code", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD" } ] }, { "id": "IntendedRecipient.addr", "path": "IntendedRecipient.addr", "short": "Australian-adapted PostalAddress datatype", "min": 0, "max": "*", "base": { "path": "IntendedRecipient.addr", "min": 0, "max": "*" }, "type": [ { "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Address" } ] }, { "id": "IntendedRecipient.telecom", "path": "IntendedRecipient.telecom", "short": "Australian-adapted TelecommunicationAddress datatype", "min": 0, "max": "*", "base": { "path": "IntendedRecipient.telecom", "min": 0, "max": "*" }, "type": [ { "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom" } ] }, { "id": "IntendedRecipient.informationRecipient", "path": "IntendedRecipient.informationRecipient", "short": "Australian-adapted Person class", "min": 0, "max": "1", "base": { "path": "IntendedRecipient.informationRecipient", "min": 0, "max": "1" }, "type": [ { "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Person", "profile": [ "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Person" ] } ] }, { "id": "IntendedRecipient.receivedOrganization", "path": "IntendedRecipient.receivedOrganization", "short": "Australian-adapted Organization class", "min": 0, "max": "1", "base": { "path": "IntendedRecipient.receivedOrganization", "min": 0, "max": "1" }, "type": [ { "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organization", "profile": [ "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organization" ] } ] } ] }, "differential": { "element": [ { "id": "IntendedRecipient", "path": "IntendedRecipient", "short": "Australian adaptation of the HL7 International CDA IntendedRecipient class", "min": 1, "max": "1" }, { "id": "IntendedRecipient.classCode", "path": "IntendedRecipient.classCode", "representation": [ "xmlAttr" ], "min": 0, "max": "1", "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "defaultValueCode": "ASSIGNED" }, { "id": "IntendedRecipient.id", "path": "IntendedRecipient.id", "min": 0, "max": "*", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ] }, { "id": "IntendedRecipient.code", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace", "valueUri": "http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0" } ], "path": "IntendedRecipient.code", "short": "ADHA CDA extension to represent intended recipient's role code", "min": 0, "max": "1", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD" } ] }, { "id": "IntendedRecipient.addr", "path": "IntendedRecipient.addr", "short": "Australian-adapted PostalAddress datatype", "min": 0, "max": "*", "type": [ { "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Address" } ] }, { "id": "IntendedRecipient.telecom", "path": "IntendedRecipient.telecom", "short": "Australian-adapted TelecommunicationAddress datatype", "min": 0, "max": "*", "type": [ { "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom" } ] }, { "id": "IntendedRecipient.informationRecipient", "path": "IntendedRecipient.informationRecipient", "short": "Australian-adapted Person class", "min": 0, "max": "1", "type": [ { "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Person", "profile": [ "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Person" ] } ] }, { "id": "IntendedRecipient.receivedOrganization", "path": "IntendedRecipient.receivedOrganization", "short": "Australian-adapted Organization class", "min": 0, "max": "1", "type": [ { "code": "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organization", "profile": [ "http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organization" ] } ] } ] } }