Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
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-core-1 | Version: 1.0.0 | |||
| Active as of 2024-09-12 | Computable Name: ADHABodyStructureCore | |||
Copyright/Legal: Copyright © 2022 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 provide a core representation of a body structure for the electronic exchange of health information 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.
Where a more specific BodyStructure profile is applicable, e.g. diagnostic result or vital signs, an implementation SHALL ensure the resource conforms to that specific profile.
This profile is designed to set a core BodyStructure standard for:
Operations, including querying, on body structures are expected to be within the context of another resource query.
This profile may be referred to by APIs, which will be listed here when available.
None.
The following profiles build on the ADHA Core BodyStructure profile to define specific roles:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseBodyStructure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  BodyStructure |
C | 0..* | AUBaseBodyStructure | Anatomical location inv-dh-bodstr-01: The body structure shall at least have a location or a description |
  active |
0..1 | boolean | Whether this record is in active use Fixed Value: true | |
| morphology |
S | 0..1 | CodeableConcept | Kind of Structure |
| location |
SC | 0..1 | CodeableConcept | Body site Binding: Body Site  (extensible)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 |
SC | 0..1 | string | Text description |
  patient |
SC | 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.location | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| BodyStructure.locationQualifier | extensible | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-bodstr-01 | error | BodyStructure | The body structure shall at least have a location or a description : location.exists() or description.exists() | |
| inv-dh-bodstr-02 | error | BodyStructure.location | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-03 | error | BodyStructure.locationQualifier | If a coded location qualifier is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-04 | error | BodyStructure.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| BodyStructure |
C | 0..* | AUBaseBodyStructure | 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 |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| 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 | 0..1 | CodeableConcept | Body site Binding: Body Site (extensible)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 |
| 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.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | |
| BodyStructure.location | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| BodyStructure.locationQualifier | extensible | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-bodstr-01 | error | BodyStructure | The body structure shall at least have a location or a description : location.exists() or description.exists() | |
| inv-dh-bodstr-02 | error | BodyStructure.location | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-03 | error | BodyStructure.locationQualifier | If a coded location qualifier is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-04 | error | BodyStructure.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| BodyStructure |
C | 0..* | AUBaseBodyStructure | 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 | 0..1 | CodeableConcept | Body site Binding: Body Site (extensible)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 | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | ||||
| BodyStructure.location | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
| BodyStructure.locationQualifier | extensible | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-bodstr-01 | error | BodyStructure | The body structure shall at least have a location or a description : location.exists() or description.exists() | |
| inv-dh-bodstr-02 | error | BodyStructure.location | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-03 | error | BodyStructure.locationQualifier | If a coded location qualifier is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-04 | error | BodyStructure.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |
This structure is derived from AUBaseBodyStructure
Differential View
This structure is derived from AUBaseBodyStructure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| BodyStructure |
C | 0..* | AUBaseBodyStructure | Anatomical location inv-dh-bodstr-01: The body structure shall at least have a location or a description |
| active |
0..1 | boolean | Whether this record is in active use Fixed Value: true | |
| morphology |
S | 0..1 | CodeableConcept | Kind of Structure |
| location |
SC | 0..1 | CodeableConcept | Body site Binding: Body Site (extensible)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 |
SC | 0..1 | string | Text description |
| patient |
SC | 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.location | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| BodyStructure.locationQualifier | extensible | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-bodstr-01 | error | BodyStructure | The body structure shall at least have a location or a description : location.exists() or description.exists() | |
| inv-dh-bodstr-02 | error | BodyStructure.location | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-03 | error | BodyStructure.locationQualifier | If a coded location qualifier is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-04 | error | BodyStructure.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| BodyStructure |
C | 0..* | AUBaseBodyStructure | 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 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| 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 | 0..1 | CodeableConcept | Body site Binding: Body Site (extensible)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 |
| 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.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | |
| BodyStructure.location | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| BodyStructure.locationQualifier | extensible | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-bodstr-01 | error | BodyStructure | The body structure shall at least have a location or a description : location.exists() or description.exists() | |
| inv-dh-bodstr-02 | error | BodyStructure.location | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-03 | error | BodyStructure.locationQualifier | If a coded location qualifier is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-04 | error | BodyStructure.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| BodyStructure |
C | 0..* | AUBaseBodyStructure | 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 | 0..1 | CodeableConcept | Body site Binding: Body Site (extensible)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 | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | ||||
| BodyStructure.location | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
| BodyStructure.locationQualifier | extensible | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-bodstr-01 | error | BodyStructure | The body structure shall at least have a location or a description : location.exists() or description.exists() | |
| inv-dh-bodstr-02 | error | BodyStructure.location | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-03 | error | BodyStructure.locationQualifier | If a coded location qualifier is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
| inv-dh-bodstr-04 | error | BodyStructure.patient | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() |
This structure is derived from AUBaseBodyStructure
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-09-12
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
