Australian Base Profiles Implementation Guide

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

This profile defines a healthcare service profile for the Australian context.

Identifiers

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

  • Healthcare Provider Identifier - HealthcareService

METeOR Description

Namespace Description

The Healthcare provider identifier—organisation (HPI-O) is the numerical identifier that uniquely identifies (network) organisations in Australia where healthcare is provided.

Examples

HealthcareService with HPI-O, ANZSIC coded class/activity types and eligibility

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 Tue Oct 10 11:30:38 AEDT 2017 as a draft by Health Level Seven Australia (Patient Administration).

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

AU Base Healthcare Service profile contains:

  1. Base: Healthcare Service (as HealthcareService)
  2. Optional Eligbility Detail Entries (as Extension)
  3. Optional HPI-O (as Identifier)
  4. Optional Healthcare Service Types (ANZSIC Class/Activity) (as Coding)
  5. Optional Healthcare Service Provider Specialties (SNOMED) (as Coding)
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*Australian healthcare service
... healthcareservice-eligibility-detail 0..*(Complex)Healthcare Service Eligibility Detail
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail
... identifier IdentifierHealthcare service identifiers
Slice: Unordered, Open by value:type, value:system
... identifier 0..*IdentifierHPI-O
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 0..1CodingHPI-O Identifier Type Code
Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"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-1: The HPI-O shall be a 16 digit number.
Example HPI-O number': 8003627500000328
... type CodeableConceptHealthcare service type
Slice: Unordered, Open by value:coding.system
... type 0..*CodeableConceptBinding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Class Only) (required)
... type 0..*CodeableConceptBinding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Activities Only) (required)
... specialty CodeableConceptHealthcare service provided specialties
Slice: Unordered, Open by value:coding.system
... specialty 0..*CodeableConceptBinding: Provider Specialties (SNOMED) (required)
... eligibility 0..1CodeableConceptPrimary eligibility criteria for service

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*Australian healthcare service
... 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
... healthcareservice-eligibility-detail I0..*(Complex)Extension
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierHealthcare service identifiers
Slice: Unordered, Open by value:type, value:system
... identifier Σ0..*IdentifierHPI-O
.... id 0..1stringxml:id (or equivalent in JSON)
.... 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)
..... coding Σ0..1CodingHPI-O Identifier Type Code

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"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-1: The HPI-O shall be a 16 digit number.
Example General': 123456
Example HPI-O number': 8003627500000328
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(OrganizationOrganization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this healthcareservice is in active use
... providedBy Σ0..1Reference(OrganizationOrganization that provides this service
... category Σ0..1CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type ΣCodeableConceptHealthcare service type
Slice: Unordered, Open by value:coding.system
Binding: ServiceType (example)
... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Class Only) (required)
... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Activities Only) (required)
... specialty ΣCodeableConceptHealthcare service provided specialties
Slice: Unordered, Open by value:coding.system
Binding: Practice Setting Code Value Set (preferred)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Provider Specialties (SNOMED) (required)
... location Σ0..*Reference(LocationLocation(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(LocationLocation(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(EndpointTechnical endpoints providing access to services operated for the location

doco Documentation for this format

AU Base Healthcare Service profile contains:

  1. Base: Healthcare Service (as HealthcareService)
  2. Optional Eligbility Detail Entries (as Extension)
  3. Optional HPI-O (as Identifier)
  4. Optional Healthcare Service Types (ANZSIC Class/Activity) (as Coding)
  5. Optional Healthcare Service Provider Specialties (SNOMED) (as Coding)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*Australian healthcare service
... healthcareservice-eligibility-detail 0..*(Complex)Healthcare Service Eligibility Detail
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail
... identifier IdentifierHealthcare service identifiers
Slice: Unordered, Open by value:type, value:system
... identifier 0..*IdentifierHPI-O
.... type 1..1CodeableConceptBinding: v2 Identifier Type - AU Extended (required)
..... coding 0..1CodingHPI-O Identifier Type Code
Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"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-1: The HPI-O shall be a 16 digit number.
Example HPI-O number': 8003627500000328
... type CodeableConceptHealthcare service type
Slice: Unordered, Open by value:coding.system
... type 0..*CodeableConceptBinding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Class Only) (required)
... type 0..*CodeableConceptBinding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Activities Only) (required)
... specialty CodeableConceptHealthcare service provided specialties
Slice: Unordered, Open by value:coding.system
... specialty 0..*CodeableConceptBinding: Provider Specialties (SNOMED) (required)
... eligibility 0..1CodeableConceptPrimary eligibility criteria for service

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*Australian healthcare service
... 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
... healthcareservice-eligibility-detail I0..*(Complex)Extension
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierHealthcare service identifiers
Slice: Unordered, Open by value:type, value:system
... identifier Σ0..*IdentifierHPI-O
.... id 0..1stringxml:id (or equivalent in JSON)
.... 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)
..... coding Σ0..1CodingHPI-O Identifier Type Code

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"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-1: The HPI-O shall be a 16 digit number.
Example General': 123456
Example HPI-O number': 8003627500000328
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(OrganizationOrganization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this healthcareservice is in active use
... providedBy Σ0..1Reference(OrganizationOrganization that provides this service
... category Σ0..1CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type ΣCodeableConceptHealthcare service type
Slice: Unordered, Open by value:coding.system
Binding: ServiceType (example)
... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Class Only) (required)
... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ANZSIC -- Australian and New Zealand Standard Industrial Classification (Activities Only) (required)
... specialty ΣCodeableConceptHealthcare service provided specialties
Slice: Unordered, Open by value:coding.system
Binding: Practice Setting Code Value Set (preferred)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Provider Specialties (SNOMED) (required)
... location Σ0..*Reference(LocationLocation(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(LocationLocation(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(EndpointTechnical 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