Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.9.3: AU Base 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 0]

This profile defines a healthcare service administration details structure that includes core localisation concepts.

Identifiers

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

  • Healthcare Provider Identifier for Organisation - HPI-O [1] [2]

Extensions

Extensions used in this profile:

  • Healthcare Service: Healthcare Service Eligibility Detail [1]

Examples

HealthcareService with HPI-O and SNOMED-CT coded specialty

Albion Hospital Radiology 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

Base profile for Australian context Healthcare Service

This profile builds on HealthcareService.

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

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

This profile contains the following variations from HealthcareService:

  1. zero or more extension sliced
    • zero or more eligibilityDetails extension
  2. zero or more identifier Healthcare service identifiers sliced
    • zero or more identifier HPI-O
  3. zero or more specialty Healthcare service provided specialties sliced
    • zero or more specialty
  4. at most one eligibility Primary eligibility criteria for service
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*A healthcare service in an Australian healthcare context
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... healthcareservice-eligibility-detail 0..*(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
Binding: https://api.healthterminologies.gov.au/integration/v2/fhir/ValueSet/common-languages-australia-1 (extensible)
... identifier IdentifierHealthcare service identifiers
Slice: Unordered, Open by value:system, value:type
... identifier 0..*IdentifierHPI-O
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 0..1CodingHPI-O Identifier Type Code
...... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
...... code 1..1codeFixed Value: NOI
..... text 1..1stringHPI-O text description
Fixed Value: HPI-O
.... system 1..1uriNamespace URI for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value I1..1stringHPI-O value
inv-hpio-0: The HPI-O shall be a 16 digit number.
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: The HPI-O Identifier shall pass the Luhn algorithm check
Example HPI-O number': 8003627500000328
... providedBy 0..1Reference(AU Base Organisation)
... specialty CodeableConceptHealthcare service provided specialties
Slice: Unordered, Open by value:coding.system
... specialty 0..*CodeableConceptHealthcare service specialty SNOMED CT
Binding: Healthcare Service Roles (SNOMED) (required)
... location 0..*Reference(AU Base Location)
... coverageArea 0..*Reference(AU Base Location)
... eligibility 0..1CodeableConceptPrimary eligibility criteria for service

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*A 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)
... 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..*(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
Binding: https://api.healthterminologies.gov.au/integration/v2/fhir/ValueSet/common-languages-australia-1 (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierHealthcare service identifiers
Slice: Unordered, Open by value:system, value:type
... identifier Σ0..*IdentifierHPI-O
.... 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 Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..1CodingHPI-O Identifier Type Code
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: NOI
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringHPI-O text description
Fixed Value: HPI-O
.... system Σ1..1uriNamespace URI for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value ΣI1..1stringHPI-O value
inv-hpio-0: The HPI-O shall be a 16 digit number.
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: The HPI-O Identifier shall pass the Luhn algorithm check
Example General': 123456
Example HPI-O number': 8003627500000328
.... 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(AU Base Organisation)Organization that provides this service
... category Σ0..1CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example)
... specialty ΣCodeableConceptHealthcare service provided specialties
Slice: Unordered, Open by value:coding.system
Binding: Practice Setting Code Value Set (preferred)
... specialty Σ0..*CodeableConceptHealthcare service specialty SNOMED CT
Binding: Healthcare Service Roles (SNOMED) (required)
... location Σ0..*Reference(AU Base 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(AU Base Location)Location(s) service is inteded for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example)
... 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

This profile contains the following variations from HealthcareService:

  1. zero or more extension sliced
    • zero or more eligibilityDetails extension
  2. zero or more identifier Healthcare service identifiers sliced
    • zero or more identifier HPI-O
  3. zero or more specialty Healthcare service provided specialties sliced
    • zero or more specialty
  4. at most one eligibility Primary eligibility criteria for service

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*A healthcare service in an Australian healthcare context
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... healthcareservice-eligibility-detail 0..*(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
Binding: https://api.healthterminologies.gov.au/integration/v2/fhir/ValueSet/common-languages-australia-1 (extensible)
... identifier IdentifierHealthcare service identifiers
Slice: Unordered, Open by value:system, value:type
... identifier 0..*IdentifierHPI-O
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 0..1CodingHPI-O Identifier Type Code
...... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
...... code 1..1codeFixed Value: NOI
..... text 1..1stringHPI-O text description
Fixed Value: HPI-O
.... system 1..1uriNamespace URI for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value I1..1stringHPI-O value
inv-hpio-0: The HPI-O shall be a 16 digit number.
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: The HPI-O Identifier shall pass the Luhn algorithm check
Example HPI-O number': 8003627500000328
... providedBy 0..1Reference(AU Base Organisation)
... specialty CodeableConceptHealthcare service provided specialties
Slice: Unordered, Open by value:coding.system
... specialty 0..*CodeableConceptHealthcare service specialty SNOMED CT
Binding: Healthcare Service Roles (SNOMED) (required)
... location 0..*Reference(AU Base Location)
... coverageArea 0..*Reference(AU Base Location)
... eligibility 0..1CodeableConceptPrimary eligibility criteria for service

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*A 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)
... 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..*(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
Binding: https://api.healthterminologies.gov.au/integration/v2/fhir/ValueSet/common-languages-australia-1 (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierHealthcare service identifiers
Slice: Unordered, Open by value:system, value:type
... identifier Σ0..*IdentifierHPI-O
.... 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 Σ1..1CodeableConceptDescription of identifier
Binding: v2 Identifier Type - AU Extended (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..1CodingHPI-O Identifier Type Code
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: NOI
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ1..1stringHPI-O text description
Fixed Value: HPI-O
.... system Σ1..1uriNamespace URI for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value ΣI1..1stringHPI-O value
inv-hpio-0: The HPI-O shall be a 16 digit number.
inv-hpio-1: HPI-O prefix is 800362
inv-hpio-2: The HPI-O Identifier shall pass the Luhn algorithm check
Example General': 123456
Example HPI-O number': 8003627500000328
.... 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(AU Base Organisation)Organization that provides this service
... category Σ0..1CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example)
... specialty ΣCodeableConceptHealthcare service provided specialties
Slice: Unordered, Open by value:coding.system
Binding: Practice Setting Code Value Set (preferred)
... specialty Σ0..*CodeableConceptHealthcare service specialty SNOMED CT
Binding: Healthcare Service Roles (SNOMED) (required)
... location Σ0..*Reference(AU Base 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(AU Base Location)Location(s) service is inteded for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example)
... 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