AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build Australia flag

AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-ps/ and changes regularly. See the Directory of published versions

Resource Profile: AU PS Organization

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-organization Version: 1.0.1-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUPSOrganization

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for an Organization resource in the context of a patient summary in an Australian context. It is based on the AU Core Organization profile, and applies the additional requirements from Organization (IPS).

See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.

Profile Specific Implementation Guidance

Examples for this Profile: Bundle/aups-basicsummary, Bundle/aups-gpvisit-retrieval, Bundle/aups-noknownx, Bundle/aups-referral-endoconsult-autogen, Bundle/aups-referral-endoconsult-curated and Bundle/aups-section-emptyreason

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
This profile also complies with the profile Organization (IPS)
Constraints: org-1
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element has obligations and must be supported. This element is included in summaries. C 0..* Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHPIO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHAE The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHSPO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPAIOIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUCSPRegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianBusinessNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianCompanyNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianRegisteredBodyNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUNATAAccreditationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPharmacyApprovalNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:hpio This element has obligations and must be supported. This element is included in summaries. C 0..1 AUHPIO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.Slices for identifier.identifier:abn This element has obligations and must be supported. This element is included in summaries. C 0..* AUAustralianBusinessNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether the organization's record is still in active use
Organization.type This element has obligations and must be supported. This element is included in summaries. 0..* CodeableConceptIPS Kind of organization
Binding: Healthcare Organisation Role Type (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.name This element has obligations and must be supported. This element is included in summaries. C 1..1 string Name used for the organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.telecom This element has obligations and must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.telecom.system This element has obligations and must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.telecom.value This element has obligations and must be supported. This element is included in summaries. 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.address This element has obligations and must be supported. C 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the organization
Constraints: org-2
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.type Base preferred Healthcare Organisation Role Type ⏿1.1.0 tx.hl7.org.au
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Organization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Organization 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 Organization 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 Organization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Organization 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()
org-1 error Organization The organization SHALL at least have a name or an identifier, and possibly more than one (identifier.count() + name.count()) > 0
org-2 error Organization.address An address of an organization can never be of use 'home' where(use = 'home').empty()
org-3 error Organization.telecom The telecom of an organization can never be of use 'home' where(use = 'home').empty()

This structure is derived from AUCoreOrganization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization 0..* AUCoreOrganization An organisation in an Australian healthcare context
This profile also complies with the profile Organization (IPS)
Organization.identifier This element has obligations. 0..* Identifier, AUHPIO, AUHAE, AUHSPO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.Slices for identifier Content/Rules for all slices
Organization.Slices for identifier.identifier:hpio This element has obligations. 0..1 AUHPIO Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.Slices for identifier.identifier:abn This element has obligations. 0..* AUAustralianBusinessNumber Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.type This element has obligations. 0..* CodeableConceptIPS Kind of organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.telecom This element has obligations. 0..* ContactPoint A contact detail for the organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.telecom.system This element has obligations. 0..1 code phone | fax | email | pager | url | sms | other
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.telecom.value This element has obligations. 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.address This element has obligations. 0..* Address, AustralianAddress An address for the organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
This profile also complies with the profile Organization (IPS)
Constraints: org-1
Organization.id This element is included in summaries. 0..1 id Logical id of this artifact
Organization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Organization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Organization.contained 0..* Resource Contained, inline Resources
Organization.extension 0..* Extension Additional content defined by implementations
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element has obligations and must be supported. This element is included in summaries. C 0..* Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHPIO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHAE The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHSPO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPAIOIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUCSPRegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianBusinessNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianCompanyNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianRegisteredBodyNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUNATAAccreditationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPharmacyApprovalNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:hpio This element has obligations and must be supported. This element is included in summaries. C 0..1 AUHPIO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.Slices for identifier.identifier:abn This element has obligations and must be supported. This element is included in summaries. C 0..* AUAustralianBusinessNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether the organization's record is still in active use
Organization.type This element has obligations and must be supported. This element is included in summaries. 0..* CodeableConceptIPS Kind of organization
Binding: Healthcare Organisation Role Type (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.name This element has obligations and must be supported. This element is included in summaries. C 1..1 string Name used for the organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
Organization.telecom This element has obligations and must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.telecom.id 0..1 string Unique id for inter-element referencing
Organization.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.telecom.system This element has obligations and must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.telecom.value This element has obligations and must be supported. This element is included in summaries. 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.address This element has obligations and must be supported. C 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the organization
Constraints: org-2
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.partOf This element is included in summaries. 0..1 Reference(Organization) The organization of which this organization forms a part
Organization.contact 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.id 0..1 string Unique id for inter-element referencing
Organization.contact.extension 0..* Extension Additional content defined by implementations
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose 0..1 CodeableConcept The type of contact
Binding: Contact Purpose (extensible)
Organization.contact.name 0..1 HumanName A name associated with the contact
Organization.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.address 0..1 Address Visiting or postal addresses for the contact
Organization.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Organization.type Base preferred Healthcare Organisation Role Type ⏿1.1.0 tx.hl7.org.au
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Organization.contact.​purpose Base extensible Contact Purpose 📦7.0.0-ci-build AU Base Implementation Guide vnull

Constraints

Id Grade Path(s) Description Expression
dom-2 error Organization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Organization 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 Organization 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 Organization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Organization 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()
org-1 error Organization The organization SHALL at least have a name or an identifier, and possibly more than one (identifier.count() + name.count()) > 0
org-2 error Organization.address An address of an organization can never be of use 'home' where(use = 'home').empty()
org-3 error Organization.telecom The telecom of an organization can never be of use 'home' where(use = 'home').empty()

This structure is derived from AUCoreOrganization

Summary

Structures

This structure refers to these other structures:

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
This profile also complies with the profile Organization (IPS)
Constraints: org-1
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element has obligations and must be supported. This element is included in summaries. C 0..* Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHPIO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHAE The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHSPO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPAIOIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUCSPRegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianBusinessNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianCompanyNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianRegisteredBodyNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUNATAAccreditationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPharmacyApprovalNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:hpio This element has obligations and must be supported. This element is included in summaries. C 0..1 AUHPIO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.Slices for identifier.identifier:abn This element has obligations and must be supported. This element is included in summaries. C 0..* AUAustralianBusinessNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether the organization's record is still in active use
Organization.type This element has obligations and must be supported. This element is included in summaries. 0..* CodeableConceptIPS Kind of organization
Binding: Healthcare Organisation Role Type (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.name This element has obligations and must be supported. This element is included in summaries. C 1..1 string Name used for the organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.telecom This element has obligations and must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.telecom.system This element has obligations and must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.telecom.value This element has obligations and must be supported. This element is included in summaries. 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.address This element has obligations and must be supported. C 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the organization
Constraints: org-2
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.type Base preferred Healthcare Organisation Role Type ⏿1.1.0 tx.hl7.org.au
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Organization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Organization 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 Organization 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 Organization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Organization 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()
org-1 error Organization The organization SHALL at least have a name or an identifier, and possibly more than one (identifier.count() + name.count()) > 0
org-2 error Organization.address An address of an organization can never be of use 'home' where(use = 'home').empty()
org-3 error Organization.telecom The telecom of an organization can never be of use 'home' where(use = 'home').empty()

Differential View

This structure is derived from AUCoreOrganization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization 0..* AUCoreOrganization An organisation in an Australian healthcare context
This profile also complies with the profile Organization (IPS)
Organization.identifier This element has obligations. 0..* Identifier, AUHPIO, AUHAE, AUHSPO, AUPAIOIdentifier, AUCSPRegistrationNumber, AUAustralianBusinessNumber, AUAustralianCompanyNumber, AUAustralianRegisteredBodyNumber, AUNATAAccreditationNumber, AUPharmacyApprovalNumber Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.Slices for identifier Content/Rules for all slices
Organization.Slices for identifier.identifier:hpio This element has obligations. 0..1 AUHPIO Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.Slices for identifier.identifier:abn This element has obligations. 0..* AUAustralianBusinessNumber Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.type This element has obligations. 0..* CodeableConceptIPS Kind of organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.name This element has obligations. 1..1 string Name used for the organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.telecom This element has obligations. 0..* ContactPoint A contact detail for the organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.telecom.system This element has obligations. 0..1 code phone | fax | email | pager | url | sms | other
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.telecom.value This element has obligations. 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.address This element has obligations. 0..* Address, AustralianAddress An address for the organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* AUCoreOrganization An organisation in an Australian healthcare context
This profile also complies with the profile Organization (IPS)
Constraints: org-1
Organization.id This element is included in summaries. 0..1 id Logical id of this artifact
Organization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Organization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Organization.contained 0..* Resource Contained, inline Resources
Organization.extension 0..* Extension Additional content defined by implementations
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element has obligations and must be supported. This element is included in summaries. C 0..* Identifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHPIO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHAE The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUHSPO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPAIOIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUCSPRegistrationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianBusinessNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianCompanyNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUAustralianRegisteredBodyNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUNATAAccreditationNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AUPharmacyApprovalNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:hpio This element has obligations and must be supported. This element is included in summaries. C 0..1 AUHPIO The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.Slices for identifier.identifier:abn This element has obligations and must be supported. This element is included in summaries. C 0..* AUAustralianBusinessNumber The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Identifies this organization across multiple systems
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether the organization's record is still in active use
Organization.type This element has obligations and must be supported. This element is included in summaries. 0..* CodeableConceptIPS Kind of organization
Binding: Healthcare Organisation Role Type (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.name This element has obligations and must be supported. This element is included in summaries. C 1..1 string Name used for the organization
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
Organization.telecom This element has obligations and must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.telecom.id 0..1 string Unique id for inter-element referencing
Organization.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.telecom.system This element has obligations and must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.telecom.value This element has obligations and must be supported. This element is included in summaries. 0..1 string The actual contact point details
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.address This element has obligations and must be supported. C 0..* Address The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well, AustralianAddress The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well An address for the organization
Constraints: org-2
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
Organization.partOf This element is included in summaries. 0..1 Reference(Organization) The organization of which this organization forms a part
Organization.contact 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.id 0..1 string Unique id for inter-element referencing
Organization.contact.extension 0..* Extension Additional content defined by implementations
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose 0..1 CodeableConcept The type of contact
Binding: Contact Purpose (extensible)
Organization.contact.name 0..1 HumanName A name associated with the contact
Organization.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.address 0..1 Address Visiting or postal addresses for the contact
Organization.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Organization.type Base preferred Healthcare Organisation Role Type ⏿1.1.0 tx.hl7.org.au
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Organization.contact.​purpose Base extensible Contact Purpose 📦7.0.0-ci-build AU Base Implementation Guide vnull

Constraints

Id Grade Path(s) Description Expression
dom-2 error Organization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Organization 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 Organization 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 Organization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Organization 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()
org-1 error Organization The organization SHALL at least have a name or an identifier, and possibly more than one (identifier.count() + name.count()) > 0
org-2 error Organization.address An address of an organization can never be of use 'home' where(use = 'home').empty()
org-3 error Organization.telecom The telecom of an organization can never be of use 'home' where(use = 'home').empty()

This structure is derived from AUCoreOrganization

Summary

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron