Australian Base Implementation Guide (AU Base 1.1.1)

This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. 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.

Extensions

Extensions used in this profile:

  • Healthcare Service: Healthcare Service Eligibility Detail [1]
  • Healthcare Service: Healthcare Service Communication [2]

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
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... healthcareservice-eligibility-detail 0..1(Complex)Healthcare Service Eligibility Detail
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail
... healthcareservice-communication 0..*CodeableConceptHealthcare Service Communication Languages
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-communication
... 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://hl7.org.au/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NOI
...... text 0..1stringFixed 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) (preferred)
... specialty 0..*CodeableConceptHealthcare service provided specialties
Binding: Healthcare Service Roles (SNOMED) (preferred)
... serviceProvisionCode 0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..1CodeableConceptPrimary eligibility criteria for service

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*HealthcareServiceA healthcare service in an Australian healthcare context
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... healthcareservice-eligibility-detail I0..1(Complex)Healthcare Service Eligibility Detail
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail
... healthcareservice-communication I0..*CodeableConceptHealthcare Service Communication Languages
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-communication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... 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
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptIdentifier type for HPI-O
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/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..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... 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 General: 123456
Example HPI-O number: 8003621566684455
Max Length: 16
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this healthcareservice is in active use
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..1CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type Σ0..*CodeableConceptHealthcare service types
Binding: Healthcare Service Types SNOMED) (preferred)
... specialty Σ0..*CodeableConceptHealthcare service provided specialties
Binding: Healthcare Service Roles (SNOMED) (preferred)
... location Σ0..*Reference(Location)Location(s) where service may be provided
... name Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1stringExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is inteded for/available to
... serviceProvisionCode 0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..1CodeableConceptPrimary eligibility criteria for service
Binding: (unbound) (example)
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that categorize the service
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example)
... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceA healthcare service in an Australian healthcare context
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... healthcareservice-eligibility-detail 0..1(Complex)Healthcare Service Eligibility Detail
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail
... healthcareservice-communication 0..*CodeableConceptHealthcare Service Communication Languages
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-communication
... 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://hl7.org.au/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NOI
...... text 0..1stringFixed 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) (preferred)
... specialty 0..*CodeableConceptHealthcare service provided specialties
Binding: Healthcare Service Roles (SNOMED) (preferred)
... serviceProvisionCode 0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..1CodeableConceptPrimary eligibility criteria for service

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*HealthcareServiceA healthcare service in an Australian healthcare context
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... healthcareservice-eligibility-detail I0..1(Complex)Healthcare Service Eligibility Detail
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail
... healthcareservice-communication I0..*CodeableConceptHealthcare Service Communication Languages
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-communication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... 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
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptIdentifier type for HPI-O
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/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..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... 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 General: 123456
Example HPI-O number: 8003621566684455
Max Length: 16
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this healthcareservice is in active use
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..1CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type Σ0..*CodeableConceptHealthcare service types
Binding: Healthcare Service Types SNOMED) (preferred)
... specialty Σ0..*CodeableConceptHealthcare service provided specialties
Binding: Healthcare Service Roles (SNOMED) (preferred)
... location Σ0..*Reference(Location)Location(s) where service may be provided
... name Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1stringExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is inteded for/available to
... serviceProvisionCode 0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..1CodeableConceptPrimary eligibility criteria for service
Binding: (unbound) (example)
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that categorize the service
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example)
... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

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