Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-bodystructure-aodr-1 | Version: 1.0.0 | |||
Active as of 2024-12-19 | Computable Name: ADHABodyStructureAODR | |||
Copyright/Legal: Copyright © 2023 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/. |
The purpose of this profile is to represent an organ or tissue that may be donated in the event of an individual's death for the electronic exchange of organ donation as recorded on the Australian Organ Donor Register between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
This profile identifies the additional constraints, extensions, and value sets that build on and extend BodyStructure that are supported.
This profile is designed to set a BodyStructure standard for:
Operations, including querying, on body structures in an AODR record of consent (BodyStructure resource) are expected to be within the context of a Consent resource query.
This profile may be referred to by APIs, which will be listed here when available.
None.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ADHABodyStructureCore
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
BodyStructure | 0..* | ADHABodyStructureCore | Anatomical location | |
location | 1..1 | CodeableConcept | Organ or tissue for donation Binding: Organ Donation Body Site (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
BodyStructure.location | required | OrganDonationBodySite https://healthterminologies.gov.au/fhir/ValueSet/organ-donation-body-site-1 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
BodyStructure | C | 0..* | ADHABodyStructureCore | Anatomical location dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management inv-bodstr-0: The body structure shall at least have location or description or an image inv-dh-bodstr-01: The body structure shall at least have a location or a description |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
active | ?!Σ | 0..1 | boolean | Whether this record is in active use ele-1: All FHIR elements must have a @value or children Fixed Value: true |
morphology | SΣ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) ele-1: All FHIR elements must have a @value or children |
location | SΣC | 1..1 | CodeableConcept | Organ or tissue for donation Binding: Organ Donation Body Site (required) ele-1: All FHIR elements must have a @value or children inv-dh-bodstr-02: If a coded body site is provided, at least one code shall be from SNOMED CT |
locationQualifier | SC | 0..* | CodeableConcept | Body site modifier Binding: Body Site Relative Site Qualifier (extensible) ele-1: All FHIR elements must have a @value or children inv-dh-bodstr-03: If a coded location qualifier is provided, at least one code shall be from SNOMED CT |
description | SΣC | 0..1 | string | Text description ele-1: All FHIR elements must have a @value or children |
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who this is about ele-1: All FHIR elements must have a @value or children inv-dh-bodstr-04: At least reference or a valid identifier shall be present |
Documentation for this format |
Path | Conformance | ValueSet | URI |
BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-code from the FHIR Standard | |
BodyStructure.location | required | OrganDonationBodySite https://healthterminologies.gov.au/fhir/ValueSet/organ-donation-body-site-1 | |
BodyStructure.locationQualifier | extensible | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
BodyStructure | C | 0..* | ADHABodyStructureCore | Anatomical location inv-bodstr-0: The body structure shall at least have location or description or an image inv-dh-bodstr-01: The body structure shall at least have a location or a description | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Bodystructure identifier | ||||
active | ?!Σ | 0..1 | boolean | Whether this record is in active use Fixed Value: true | ||||
morphology | SΣ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) | ||||
location | SΣC | 1..1 | CodeableConcept | Organ or tissue for donation Binding: Organ Donation Body Site (required) inv-dh-bodstr-02: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||
locationQualifier | SC | 0..* | CodeableConcept | Body site modifier Binding: Body Site Relative Site Qualifier (extensible) inv-dh-bodstr-03: If a coded location qualifier is provided, at least one code shall be from SNOMED CT | ||||
description | SΣC | 0..1 | string | Text description | ||||
image | C | 0..* | Attachment | Attached images | ||||
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who this is about inv-dh-bodstr-04: At least reference or a valid identifier shall be present | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
BodyStructure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-code from the FHIR Standard | ||||
BodyStructure.location | required | OrganDonationBodySite https://healthterminologies.gov.au/fhir/ValueSet/organ-donation-body-site-1 | ||||
BodyStructure.locationQualifier | extensible | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
This structure is derived from ADHABodyStructureCore
Differential View
This structure is derived from ADHABodyStructureCore
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
BodyStructure | 0..* | ADHABodyStructureCore | Anatomical location | |
location | 1..1 | CodeableConcept | Organ or tissue for donation Binding: Organ Donation Body Site (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
BodyStructure.location | required | OrganDonationBodySite https://healthterminologies.gov.au/fhir/ValueSet/organ-donation-body-site-1 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
BodyStructure | C | 0..* | ADHABodyStructureCore | Anatomical location dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management inv-bodstr-0: The body structure shall at least have location or description or an image inv-dh-bodstr-01: The body structure shall at least have a location or a description |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
active | ?!Σ | 0..1 | boolean | Whether this record is in active use ele-1: All FHIR elements must have a @value or children Fixed Value: true |
morphology | SΣ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) ele-1: All FHIR elements must have a @value or children |
location | SΣC | 1..1 | CodeableConcept | Organ or tissue for donation Binding: Organ Donation Body Site (required) ele-1: All FHIR elements must have a @value or children inv-dh-bodstr-02: If a coded body site is provided, at least one code shall be from SNOMED CT |
locationQualifier | SC | 0..* | CodeableConcept | Body site modifier Binding: Body Site Relative Site Qualifier (extensible) ele-1: All FHIR elements must have a @value or children inv-dh-bodstr-03: If a coded location qualifier is provided, at least one code shall be from SNOMED CT |
description | SΣC | 0..1 | string | Text description ele-1: All FHIR elements must have a @value or children |
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who this is about ele-1: All FHIR elements must have a @value or children inv-dh-bodstr-04: At least reference or a valid identifier shall be present |
Documentation for this format |
Path | Conformance | ValueSet | URI |
BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-code from the FHIR Standard | |
BodyStructure.location | required | OrganDonationBodySite https://healthterminologies.gov.au/fhir/ValueSet/organ-donation-body-site-1 | |
BodyStructure.locationQualifier | extensible | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
BodyStructure | C | 0..* | ADHABodyStructureCore | Anatomical location inv-bodstr-0: The body structure shall at least have location or description or an image inv-dh-bodstr-01: The body structure shall at least have a location or a description | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Bodystructure identifier | ||||
active | ?!Σ | 0..1 | boolean | Whether this record is in active use Fixed Value: true | ||||
morphology | SΣ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) | ||||
location | SΣC | 1..1 | CodeableConcept | Organ or tissue for donation Binding: Organ Donation Body Site (required) inv-dh-bodstr-02: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||
locationQualifier | SC | 0..* | CodeableConcept | Body site modifier Binding: Body Site Relative Site Qualifier (extensible) inv-dh-bodstr-03: If a coded location qualifier is provided, at least one code shall be from SNOMED CT | ||||
description | SΣC | 0..1 | string | Text description | ||||
image | C | 0..* | Attachment | Attached images | ||||
patient | SΣC | 1..1 | Reference(ADHA Core Patient) | Who this is about inv-dh-bodstr-04: At least reference or a valid identifier shall be present | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
BodyStructure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-code from the FHIR Standard | ||||
BodyStructure.location | required | OrganDonationBodySite https://healthterminologies.gov.au/fhir/ValueSet/organ-donation-body-site-1 | ||||
BodyStructure.locationQualifier | extensible | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
This structure is derived from ADHABodyStructureCore
Other representations of profile: CSV, Excel, Schematron
No mandatory or optional search parameters for ADHA Organ or Tissue for Donation BodyStructure profile.