Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-healthcareservice

AU Base HealthcareService [FMM Level 3]

This profile defines a healthcare service administration details structure that includes core localisation concepts for use in an Australian context.

Identifiers

These definitions represent common data held in the HealthcareService.identifier element:

  • Healthcare Provider Identifier for Organisation - HPI-O [1] [2] HPI-O is used as an identifier in this healthcare service profile to support the case where network HPI-Os are issued for sub-organisations, departments or other logical divisions acting as specific healthcare services. This is useful in the abscence of any specific national identifier for healthcare service entities.

Conversion

NOTE: AU Base on STU3 included two extensions Healthcare Service Eligibility Detail, and Healthcare Service Communication which are now no longer required as direct R4 support is available.

Examples

HealthcareService with HPI-O and SNOMED-CT coded specialty

Albion Hospital Radiology Service

Albion Hospital Pathology Service

Strahan General Practitioner Services

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-healthcareservice

This profile defines a healthcare service administration details structure that includes core localisation concepts for use in an Australian context.

This profile builds on HealthcareService.

This profile was published on Fri Aug 03 00:00:00 AEST 2018 as a active by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceA healthcare service in an Australian healthcare context
... identifier 0..*(Slice Definition)Healthcare service identifiers
Slice: Unordered, Open by pattern:type, value:system
.... identifier:hpio I0..*IdentifierHealthcare Provider Identifier – Organisation (HPI-O)
inv-hpio-0: HPI-O shall be an exactly 16 digit number
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: HPI-O shall pass the Luhn algorithm check
..... type 0..1CodeableConceptIdentifier type for HPI-O
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NOI
...... text 0..1stringPlain text representation of the concept
Fixed Value: HPI-O
..... system 1..1uriNamespace for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
..... value 1..1stringHPI-O number
Example HPI-O number: 8003621566684455
Max Length: 16
... type 0..*CodeableConceptHealthcare service types
Binding: Healthcare Service Types SNOMED-CT (preferred)
... specialty 0..*CodeableConceptHealthcare service provided specialties
Binding: Healthcare Service Specialties (SNOMED) (preferred)
... serviceProvisionCode 0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*HealthcareServiceA healthcare service in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Healthcare service identifiers
Slice: Unordered, Open by pattern:type, value:system
.... identifier:hpio ΣI0..*IdentifierHealthcare Provider Identifier – Organisation (HPI-O)
inv-hpio-0: HPI-O shall be an exactly 16 digit number
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: HPI-O shall pass the Luhn algorithm check
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptIdentifier type for HPI-O
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NOI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
Fixed Value: HPI-O
..... system ΣI1..1uriNamespace for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
..... value ΣI1..1stringHPI-O number
Example General: 123456
Example HPI-O number: 8003621566684455
Max Length: 16
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether this HealthcareService record is in active use
... providedBy ΣI0..1Reference(Organization)Organization that provides this service
... category ΣI0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type ΣI0..*CodeableConceptHealthcare service types
Binding: Healthcare Service Types SNOMED-CT (preferred)
... specialty ΣI0..*CodeableConceptHealthcare service provided specialties
Binding: Healthcare Service Specialties (SNOMED) (preferred)
... location ΣI0..*Reference(Location)Location(s) where service may be provided
... name ΣI0..1stringDescription of service as presented to a consumer while searching
... comment ΣI0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails I0..1markdownExtra details about the service that can't be placed in the other fields
... photo ΣI0..1AttachmentFacilitates quick identification of the service
... telecom I0..*ContactPointContacts related to the healthcare service
... coverageArea I0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode I0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility I0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code I0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example)
.... comment I0..1markdownDescribes the eligibility conditions for the service
... program I0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example)
... characteristic I0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example)
... communication I0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... referralMethod I0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example)
... appointmentRequired I0..1booleanIf an appointment is required for access to this service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime I0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime I0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I1..1stringReason presented to the user explaining why time not available
.... during I0..1PeriodService not available from this date
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceA healthcare service in an Australian healthcare context
... identifier 0..*(Slice Definition)Healthcare service identifiers
Slice: Unordered, Open by pattern:type, value:system
.... identifier:hpio I0..*IdentifierHealthcare Provider Identifier – Organisation (HPI-O)
inv-hpio-0: HPI-O shall be an exactly 16 digit number
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: HPI-O shall pass the Luhn algorithm check
..... type 0..1CodeableConceptIdentifier type for HPI-O
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NOI
...... text 0..1stringPlain text representation of the concept
Fixed Value: HPI-O
..... system 1..1uriNamespace for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
..... value 1..1stringHPI-O number
Example HPI-O number: 8003621566684455
Max Length: 16
... type 0..*CodeableConceptHealthcare service types
Binding: Healthcare Service Types SNOMED-CT (preferred)
... specialty 0..*CodeableConceptHealthcare service provided specialties
Binding: Healthcare Service Specialties (SNOMED) (preferred)
... serviceProvisionCode 0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*HealthcareServiceA healthcare service in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Healthcare service identifiers
Slice: Unordered, Open by pattern:type, value:system
.... identifier:hpio ΣI0..*IdentifierHealthcare Provider Identifier – Organisation (HPI-O)
inv-hpio-0: HPI-O shall be an exactly 16 digit number
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: HPI-O shall pass the Luhn algorithm check
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptIdentifier type for HPI-O
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NOI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
Fixed Value: HPI-O
..... system ΣI1..1uriNamespace for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
..... value ΣI1..1stringHPI-O number
Example General: 123456
Example HPI-O number: 8003621566684455
Max Length: 16
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether this HealthcareService record is in active use
... providedBy ΣI0..1Reference(Organization)Organization that provides this service
... category ΣI0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type ΣI0..*CodeableConceptHealthcare service types
Binding: Healthcare Service Types SNOMED-CT (preferred)
... specialty ΣI0..*CodeableConceptHealthcare service provided specialties
Binding: Healthcare Service Specialties (SNOMED) (preferred)
... location ΣI0..*Reference(Location)Location(s) where service may be provided
... name ΣI0..1stringDescription of service as presented to a consumer while searching
... comment ΣI0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails I0..1markdownExtra details about the service that can't be placed in the other fields
... photo ΣI0..1AttachmentFacilitates quick identification of the service
... telecom I0..*ContactPointContacts related to the healthcare service
... coverageArea I0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode I0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility I0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code I0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example)
.... comment I0..1markdownDescribes the eligibility conditions for the service
... program I0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example)
... characteristic I0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example)
... communication I0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... referralMethod I0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example)
... appointmentRequired I0..1booleanIf an appointment is required for access to this service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime I0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime I0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I1..1stringReason presented to the user explaining why time not available
.... during I0..1PeriodService not available from this date
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-healthcareservice

none defined