AU Base Implementation Guide
5.0.0 - Working Standard
AU Base Implementation Guide
5.0.0 - Working Standard
This page is part of the Australian Base IG (v5.0.0: R4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/StructureDefinition/au-bodystructure | Version: 5.0.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: AUBaseBodyStructure | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile defines a body structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from BodyStructure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  BodyStructure |
C | 0..* | BodyStructure | An identified anatomical structure in an Australian healthcare context inv-bodstr-0: The body structure shall at least have location or description or an image |
  morphology |
0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) | |
| location |
C | 0..1 | CodeableConcept | Body site Binding: Body Site  (preferred) |
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Site Relative Site Qualifier (preferred) | |
| description |
C | 0..1 | string | Text description |
 image |
C | 0..* | Attachment | Attached images |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | |
| BodyStructure.location | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| BodyStructure.locationQualifier | preferred | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-bodstr-0 | error | BodyStructure | The body structure shall at least have location or description or an image : location.exists() or description.exists() or image.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| BodyStructure |
C | 0..* | BodyStructure | An identified anatomical structure in an Australian healthcare context 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 |
 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 |
 morphology |
Σ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) ele-1: All FHIR elements must have a @value or children |
| location |
ΣC | 0..1 | CodeableConcept | Body site Binding: Body Site (preferred)ele-1: All FHIR elements must have a @value or children |
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Site Relative Site Qualifier (preferred)ele-1: All FHIR elements must have a @value or children | |
| description |
ΣC | 0..1 | string | Text description ele-1: All FHIR elements must have a @value or children |
| image |
C | 0..* | Attachment | Attached images ele-1: All FHIR elements must have a @value or children |
 patient |
Σ | 1..1 | Reference(Patient) | Who this is about ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | |
| BodyStructure.location | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| BodyStructure.locationQualifier | preferred | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | BodyStructure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | BodyStructure | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | BodyStructure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-bodstr-0 | error | BodyStructure | The body structure shall at least have location or description or an image : location.exists() or description.exists() or image.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| BodyStructure |
C | 0..* | BodyStructure | An identified anatomical structure in an Australian healthcare context inv-bodstr-0: The body structure shall at least have location or description or an image | ||||
| 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 | ||||
| morphology |
Σ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) | ||||
| location |
ΣC | 0..1 | CodeableConcept | Body site Binding: Body Site (preferred) | ||||
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Site Relative Site Qualifier (preferred) | |||||
| description |
ΣC | 0..1 | string | Text description | ||||
| image |
C | 0..* | Attachment | Attached images | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who this is about | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| BodyStructure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | ||||
| BodyStructure.location | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
| BodyStructure.locationQualifier | preferred | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | BodyStructure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | BodyStructure | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | BodyStructure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-bodstr-0 | error | BodyStructure | The body structure shall at least have location or description or an image : location.exists() or description.exists() or image.exists() |
This structure is derived from BodyStructure
Differential View
This structure is derived from BodyStructure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| BodyStructure |
C | 0..* | BodyStructure | An identified anatomical structure in an Australian healthcare context inv-bodstr-0: The body structure shall at least have location or description or an image |
| morphology |
0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) | |
| location |
C | 0..1 | CodeableConcept | Body site Binding: Body Site (preferred) |
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Site Relative Site Qualifier (preferred) | |
| description |
C | 0..1 | string | Text description |
| image |
C | 0..* | Attachment | Attached images |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | |
| BodyStructure.location | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| BodyStructure.locationQualifier | preferred | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-bodstr-0 | error | BodyStructure | The body structure shall at least have location or description or an image : location.exists() or description.exists() or image.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| BodyStructure |
C | 0..* | BodyStructure | An identified anatomical structure in an Australian healthcare context 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 |
| 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 |
| morphology |
Σ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) ele-1: All FHIR elements must have a @value or children |
| location |
ΣC | 0..1 | CodeableConcept | Body site Binding: Body Site (preferred)ele-1: All FHIR elements must have a @value or children |
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Site Relative Site Qualifier (preferred)ele-1: All FHIR elements must have a @value or children | |
| description |
ΣC | 0..1 | string | Text description ele-1: All FHIR elements must have a @value or children |
| image |
C | 0..* | Attachment | Attached images ele-1: All FHIR elements must have a @value or children |
| patient |
Σ | 1..1 | Reference(Patient) | Who this is about ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | |
| BodyStructure.location | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | |
| BodyStructure.locationQualifier | preferred | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | BodyStructure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | BodyStructure | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | BodyStructure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-bodstr-0 | error | BodyStructure | The body structure shall at least have location or description or an image : location.exists() or description.exists() or image.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| BodyStructure |
C | 0..* | BodyStructure | An identified anatomical structure in an Australian healthcare context inv-bodstr-0: The body structure shall at least have location or description or an image | ||||
| 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 | ||||
| morphology |
Σ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) | ||||
| location |
ΣC | 0..1 | CodeableConcept | Body site Binding: Body Site (preferred) | ||||
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Site Relative Site Qualifier (preferred) | |||||
| description |
ΣC | 0..1 | string | Text description | ||||
| image |
C | 0..* | Attachment | Attached images | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who this is about | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| BodyStructure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | ||||
| BodyStructure.location | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
| BodyStructure.locationQualifier | preferred | BodySiteRelativeSiteQualifier https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | BodyStructure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | BodyStructure | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | BodyStructure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-bodstr-0 | error | BodyStructure | The body structure shall at least have location or description or an image : location.exists() or description.exists() or image.exists() |
This structure is derived from BodyStructure
Other representations of profile: CSV, Excel, Schematron
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#5.0.0 based on FHIR 4.0.1. Generated 2025-01-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change