AU Base Implementation Guide
4.2.0-preview - Working Australia flag

This page is part of the Australian Base IG (v4.2.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Base Body Structure

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-bodystructure Version: 4.2.0-preview
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 Notes

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from BodyStructure

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure C0..*BodyStructureAn 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..1CodeableConceptKind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (preferred)
... location C0..1CodeableConceptBody site
Binding: Body Site . (preferred)
... locationQualifier 0..*CodeableConceptBody site modifier
Binding: Body Site Relative Site Qualifier . (preferred)
... image C0..*AttachmentAttached images

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
from the FHIR Standard
BodyStructure.locationpreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
BodyStructure.locationQualifierpreferredBodySiteRelativeSiteQualifier .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1

Constraints

IdGradePath(s)DetailsRequirements
inv-bodstr-0errorBodyStructureThe body structure shall at least have location or description or an image
: location.exists() or description.exists() or image.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure C0..*BodyStructureAn identified anatomical structure in an Australian healthcare context
inv-bodstr-0: The body structure shall at least have location or description or an image
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!Σ0..1booleanWhether this record is in active use
... location ΣC0..1CodeableConceptBody site
Binding: Body Site . (preferred)
... locationQualifier 0..*CodeableConceptBody site modifier
Binding: Body Site Relative Site Qualifier . (preferred)
... description ΣC0..1stringText description
... image C0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
from the FHIR Standard
BodyStructure.locationpreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
BodyStructure.locationQualifierpreferredBodySiteRelativeSiteQualifier .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBodyStructureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBodyStructureIf 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-4errorBodyStructureIf 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-5errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBodyStructureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-bodstr-0errorBodyStructureThe body structure shall at least have location or description or an image
: location.exists() or description.exists() or image.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure C0..*BodyStructureAn 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBodystructure identifier
... active ?!Σ0..1booleanWhether this record is in active use
... morphology Σ0..1CodeableConceptKind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (preferred)
... location ΣC0..1CodeableConceptBody site
Binding: Body Site . (preferred)
... locationQualifier 0..*CodeableConceptBody site modifier
Binding: Body Site Relative Site Qualifier . (preferred)
... description ΣC0..1stringText description
... image C0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
from the FHIR Standard
BodyStructure.locationpreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
BodyStructure.locationQualifierpreferredBodySiteRelativeSiteQualifier .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBodyStructureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBodyStructureIf 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-4errorBodyStructureIf 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-5errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBodyStructureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-bodstr-0errorBodyStructureThe 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

Summary

Maturity: 1

Differential View

This structure is derived from BodyStructure

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure C0..*BodyStructureAn 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..1CodeableConceptKind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (preferred)
... location C0..1CodeableConceptBody site
Binding: Body Site . (preferred)
... locationQualifier 0..*CodeableConceptBody site modifier
Binding: Body Site Relative Site Qualifier . (preferred)
... image C0..*AttachmentAttached images

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
from the FHIR Standard
BodyStructure.locationpreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
BodyStructure.locationQualifierpreferredBodySiteRelativeSiteQualifier .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1

Constraints

IdGradePath(s)DetailsRequirements
inv-bodstr-0errorBodyStructureThe body structure shall at least have location or description or an image
: location.exists() or description.exists() or image.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure C0..*BodyStructureAn identified anatomical structure in an Australian healthcare context
inv-bodstr-0: The body structure shall at least have location or description or an image
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!Σ0..1booleanWhether this record is in active use
... location ΣC0..1CodeableConceptBody site
Binding: Body Site . (preferred)
... locationQualifier 0..*CodeableConceptBody site modifier
Binding: Body Site Relative Site Qualifier . (preferred)
... description ΣC0..1stringText description
... image C0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
from the FHIR Standard
BodyStructure.locationpreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
BodyStructure.locationQualifierpreferredBodySiteRelativeSiteQualifier .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBodyStructureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBodyStructureIf 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-4errorBodyStructureIf 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-5errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBodyStructureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-bodstr-0errorBodyStructureThe body structure shall at least have location or description or an image
: location.exists() or description.exists() or image.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure C0..*BodyStructureAn 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBodystructure identifier
... active ?!Σ0..1booleanWhether this record is in active use
... morphology Σ0..1CodeableConceptKind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (preferred)
... location ΣC0..1CodeableConceptBody site
Binding: Body Site . (preferred)
... locationQualifier 0..*CodeableConceptBody site modifier
Binding: Body Site Relative Site Qualifier . (preferred)
... description ΣC0..1stringText description
... image C0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
from the FHIR Standard
BodyStructure.locationpreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
BodyStructure.locationQualifierpreferredBodySiteRelativeSiteQualifier .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-relative-site-qualifier-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorBodyStructureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBodyStructureIf 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-4errorBodyStructureIf 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-5errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBodyStructureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-bodstr-0errorBodyStructureThe 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

Summary

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron