Australian Provider Directory Implementation Guide (PD 2.1)

Implementation Guide Template, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/hl7au/au-fhir-pd/ and changes regularly. See the Directory of published versions

SD.6 StructureDefinition-au-pd-healthcareservice

Australian Healthcare Service Directory Entry Profile

Provider directory entry for a healthcare service or category of services delivered at a location by an organisation. In a provider directory this allows the association of endpoints with the healthcare service and thus a channel for delivery to that service.

SD.6.1 Formal Views of Profile Content

The official URL for this profile is:

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

This profile builds on AUBaseHealthcareService.

This profile was published on Mon May 03 02:23:16 UTC 2021 as a draft by HL7 Australia.

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

Australian Healthcare Service Directory Entry

  1. Must Support Optional: Meta-Source (uri)
  2. Must Support 0 or more: HPI-O (Identifier)
    • Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
  3. Must Support Optional: Secure Messaging Vendor’s Provider Identifier (Identifier)
    • Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
  4. Must Support Required: Active Status (boolean)
  5. Must Support Required: Organisation - provided by (Reference)
  6. Must Support 0 or more: Type Codes (Coding)
  7. Must Support 0 or more: Specialties (Coding)
  8. Must Support Required: Location (Reference)
  9. Must Support Required: Service Name (string)
  10. Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
  11. Must Support 0 or more: Endpoints, secure messaging or others (Reference)
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AUBaseHealthcareServiceA healthcare service in an Australian healthcare context
... meta 0..1MetaMetadata on Healthcare Service
.... source S0..1uriIdentifies where the resource comes from
... identifier S0..*(Slice Definition)External identifiers for this item
Slice: Unordered, Open by pattern:type, value:system
.... identifier:All Slices Content/Rules for all slices
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-routability 0..*(Complex)Identifier routability
URL: http://hl7.org.au/fhir/StructureDefinition/identifier-routability
..... au-assigningauthority 0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
.... identifier:hpio S0..*AUHPIOHPI-O for Directory Entry Organisation
.... identifier:pdvendor S0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
..... type 1..1CodeableConceptVendor Directory Identifier Type
Binding: V2 Identifier Type - AU Extended (required): Local Identifier Type

...... coding 1..1CodingVendor Directory Identifier
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeSymbol in syntax defined by the system
Fixed Value: VDI
...... text 1..1stringVendor Directory Identifier Type
Fixed Value: Vendor Directory Identifier
..... system 1..1uriVendor allocated URL
..... value 1..1stringVendor Identifier Value
..... assigner 1..1Reference(Organization)Secure messaging vendor organisation
...... display 1..1stringSecure messaging vendor organisation name
... active S1..1booleanRequired status
... providedBy S1..1Reference(AU PD Organisation)Providing organisation
... type S0..*CodeableConceptDirectory SNOMED-CT service types
... specialty S0..*CodeableConceptDirectory SNOMED-CT specialties offered by the HealthcareService
... location S1..1Reference(AU PD Location)Single location for this service
... name S1..1stringHealthcare service name
... telecom S0..*ContactPointContact details
... availableTime
.... availableStartTime
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension:timeZone 0..1AustralianTimeZoneAU Time Zone
...... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Open by type:$this
.... availableEndTime
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension:timeZone 0..1AustralianTimeZoneAU Time Zone
...... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Open by type:$this
... endpoint S0..*Reference(AU PD Secure Messaging Endpoint)Technical endpoints for this healthcare service.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AUBaseHealthcareServiceA healthcare service in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata on Healthcare Service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source SΣ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*(Slice Definition)External identifiers for this item
Slice: Unordered, Open by pattern:type, value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-routability 0..*(Complex)Identifier routability
URL: http://hl7.org.au/fhir/StructureDefinition/identifier-routability
..... au-assigningauthority 0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:hpio SI0..*AUHPIOHPI-O for Directory Entry Organisation
.... identifier:pdvendor S0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptVendor Directory Identifier Type
Binding: V2 Identifier Type - AU Extended (required): Local Identifier Type

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingVendor Directory Identifier
....... id 0..1stringUnique id for inter-element referencing
....... 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: VDI
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ1..1stringVendor Directory Identifier Type
Fixed Value: Vendor Directory Identifier
..... system Σ1..1uriVendor allocated URL
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringVendor Identifier Value
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(Organization)Secure messaging vendor organisation
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringSecure messaging vendor organisation name
... active ?!SΣ1..1booleanRequired status
... providedBy SΣ1..1Reference(AU PD Organisation)Providing organisation
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type SΣ0..*CodeableConceptDirectory SNOMED-CT service types
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (preferred): A type of service that a healthcare service may provide.


... specialty SΣ0..*CodeableConceptDirectory SNOMED-CT specialties offered by the HealthcareService
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred): A specialty role that a healthcare service may provide.


... location SΣ1..1Reference(AU PD Location)Single location for this service
... name SΣ1..1stringHealthcare service name
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointContact details
... coverageArea 0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode 0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.


... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... au-timezone 0..1CodeableConceptAU Time Zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-timezone"
...... value[x]:valueCodeableConcept 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... au-timezone 0..1CodeableConceptAU Time Zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-timezone"
...... value[x]:valueCodeableConcept 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(AU PD Secure Messaging Endpoint)Technical endpoints for this healthcare service.

doco Documentation for this format

Australian Healthcare Service Directory Entry

  1. Must Support Optional: Meta-Source (uri)
  2. Must Support 0 or more: HPI-O (Identifier)
    • Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
  3. Must Support Optional: Secure Messaging Vendor’s Provider Identifier (Identifier)
    • Must Support Optional Extension: Optional HL7 V2 routing content (Complex)
  4. Must Support Required: Active Status (boolean)
  5. Must Support Required: Organisation - provided by (Reference)
  6. Must Support 0 or more: Type Codes (Coding)
  7. Must Support 0 or more: Specialties (Coding)
  8. Must Support Required: Location (Reference)
  9. Must Support Required: Service Name (string)
  10. Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
  11. Must Support 0 or more: Endpoints, secure messaging or others (Reference)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AUBaseHealthcareServiceA healthcare service in an Australian healthcare context
... meta 0..1MetaMetadata on Healthcare Service
.... source S0..1uriIdentifies where the resource comes from
... identifier S0..*(Slice Definition)External identifiers for this item
Slice: Unordered, Open by pattern:type, value:system
.... identifier:All Slices Content/Rules for all slices
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-routability 0..*(Complex)Identifier routability
URL: http://hl7.org.au/fhir/StructureDefinition/identifier-routability
..... au-assigningauthority 0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
.... identifier:hpio S0..*AUHPIOHPI-O for Directory Entry Organisation
.... identifier:pdvendor S0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
..... type 1..1CodeableConceptVendor Directory Identifier Type
Binding: V2 Identifier Type - AU Extended (required): Local Identifier Type

...... coding 1..1CodingVendor Directory Identifier
....... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code 1..1codeSymbol in syntax defined by the system
Fixed Value: VDI
...... text 1..1stringVendor Directory Identifier Type
Fixed Value: Vendor Directory Identifier
..... system 1..1uriVendor allocated URL
..... value 1..1stringVendor Identifier Value
..... assigner 1..1Reference(Organization)Secure messaging vendor organisation
...... display 1..1stringSecure messaging vendor organisation name
... active S1..1booleanRequired status
... providedBy S1..1Reference(AU PD Organisation)Providing organisation
... type S0..*CodeableConceptDirectory SNOMED-CT service types
... specialty S0..*CodeableConceptDirectory SNOMED-CT specialties offered by the HealthcareService
... location S1..1Reference(AU PD Location)Single location for this service
... name S1..1stringHealthcare service name
... telecom S0..*ContactPointContact details
... availableTime
.... availableStartTime
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension:timeZone 0..1AustralianTimeZoneAU Time Zone
...... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Open by type:$this
.... availableEndTime
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension:timeZone 0..1AustralianTimeZoneAU Time Zone
...... value[x] 1..1(Slice Definition)Value of extension
Slice: Unordered, Open by type:$this
... endpoint S0..*Reference(AU PD Secure Messaging Endpoint)Technical endpoints for this healthcare service.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AUBaseHealthcareServiceA healthcare service in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata on Healthcare Service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source SΣ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*(Slice Definition)External identifiers for this item
Slice: Unordered, Open by pattern:type, value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-routability 0..*(Complex)Identifier routability
URL: http://hl7.org.au/fhir/StructureDefinition/identifier-routability
..... au-assigningauthority 0..1(Complex)HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:hpio SI0..*AUHPIOHPI-O for Directory Entry Organisation
.... identifier:pdvendor S0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptVendor Directory Identifier Type
Binding: V2 Identifier Type - AU Extended (required): Local Identifier Type

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingVendor Directory Identifier
....... id 0..1stringUnique id for inter-element referencing
....... 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: VDI
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ1..1stringVendor Directory Identifier Type
Fixed Value: Vendor Directory Identifier
..... system Σ1..1uriVendor allocated URL
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringVendor Identifier Value
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(Organization)Secure messaging vendor organisation
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ1..1stringSecure messaging vendor organisation name
... active ?!SΣ1..1booleanRequired status
... providedBy SΣ1..1Reference(AU PD Organisation)Providing organisation
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type SΣ0..*CodeableConceptDirectory SNOMED-CT service types
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (preferred): A type of service that a healthcare service may provide.


... specialty SΣ0..*CodeableConceptDirectory SNOMED-CT specialties offered by the HealthcareService
Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred): A specialty role that a healthcare service may provide.


... location SΣ1..1Reference(AU PD Location)Single location for this service
... name SΣ1..1stringHealthcare service name
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom S0..*ContactPointContact details
... coverageArea 0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode 0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.


... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... au-timezone 0..1CodeableConceptAU Time Zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-timezone"
...... value[x]:valueCodeableConcept 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... au-timezone 0..1CodeableConceptAU Time Zone
URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone
Binding: AU Time Zone (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-timezone"
...... value[x]:valueCodeableConcept 1..1(Slice Definition)Value of extension
Slice: Unordered, Closed by type:$this
Binding: AU Time Zone (required)
..... value 0..1timePrimitive value for time
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(AU PD Secure Messaging Endpoint)Technical endpoints for this healthcare service.

doco Documentation for this format

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

 

SD.6.2 Quick Start

Below is an overview of the requirements for search and read operations.


Read: HealthcareService

Read identified healthcare service resource content.

GET [base]/HealthcareService/[id]

Example: GET [base]/HealthcareService/1234

Support:

  • MUST support read HealthcareService

Implementation Notes: [(how to read resource)


Search: Active Status

Search based on active status of the healthcare service record.

GET [base]/HealthcareService?active=[status]

Example: GET [base]/HealthcareService?active=true

Support: MUST support search HealthcareService by active status (true | false).

Implementation Notes: (how to search by token)


Search: Name

Search for a healthcare service by name.

GET [base]/HealthcareService?name=[string]

Example: GET [base]/HealthcareService?name=southern%20clinic

Support:

  • MUST support search by HealthcareService name.

Implementation Notes: (how to search by string)


Search: Organisation Provider of Healthcare Service Name

Chained search (via Organisation) based on text name.

GET [base]/HealthcareService?organization.name=[string]

Example: GET [base]/HealthcareService?organization.name=clinigroup

Support:

  • MUST support search by Organization name.

Implementation Notes: (how to search by string)


Search: Healthcare Service Type

Search for healthcare service based on type of service

GET [base]/HealthcareService?service-type=[system]|[code]

Example: GET [base]/HealthcareService?service-type=http://snomed.info/sct|310030000

Support:

  • MUST support search by HealthcareService service-type.

Implementation Notes: (how to search by token)


Search: Healthcare Service offered Specialties

Search for healthcare service based on specialties offered

GET [base]/HealthcareService?specialty=[system]|[code]

Example: GET [base]/HealthcareService?specialty=http://snomed.info/sct|394582007

Support:

  • MUST support search by HealthcareService specialty offered.

Implementation Notes: (how to search by token)


Search: Organisation provider of Healthcare Service HPI-O

Chained search (via Organisation) based on identifier token.

GET [base]/HealthcareService?organization.identifier=[system]|[value]

Example: GET [base]/HealthcareService?organization.identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003627500000328

Support:

  • MUST support search by HPI-O.

Implementation Notes: (how to search by token)


Search: HPI-O Search based on identifier token. Direct HPI-O allocation to the service; may be different than the providing organisation but within the HPI-O hierarchy (networked HPI-O).

GET [base]/HealthcareService?identifier=[system]|[value]

Example: GET [base]/HealthcareService?identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003627500000328

Support:

  • MUST support search by HPI-O.

Implementation Notes: (how to search by token)


Search: Location Address Parts

Chained search (via Location) based on address parts for postcode, suburb, and state.

GET [base]/HealthcareService?location.address-postalcode=[postcode]

GET [base]/HealthcareService?location.address-city=[suburb]

GET [base]/HealthcareService?location.address-state=[state]

Example:

GET [base]/HealthcareService?location.address-postalcode=3101

GET [base]/HealthcareService?location.address-city=Bundaberg

GET [base]/HealthcareService?location.address-state=VIC

Support:

  • MUST support search PractitionerRole by location address parts address-postalcode, address-city, address-state.
  • MUST support basic param=[string] search which is case and accent-insensitive search; field equals or starts with the string value.

Implementation Notes: (how to search by token)


Search: Location Distance

Chained search (via Location) for a location within a nominated distance.

GET [base]/HealthcareService?location.near=[latitude]:[longitude]&location.near-distance=[prefix][value]|[units-system]|[units]

Example: GET [base]/HealthcareService?location.near=-83.694810:42.256500&location.near-distance=le10.0|http://unitsofmeasure.org|km

Support:

  • SHOULD support search PractitionerRole by location within a distance.
  • SHOULD support: [prefix] fixed ‘le’ is less than or equal to distance [value] is a decimal quantity number [units-system] fixed ‘http://unitsofmeasure.org’ identifies standard distance units are used [units] distance units must support ‘km’ or ‘m’

Implementation Notes: (how to search by token) and (how to search by quantity)


Search: Connection Type (Service Interface)

Chained search (via Endpoint) based on token for a protocol to be used to connnect to the endpoint.

GET [base]/HealthcareService?endpoint.connection-type=[system]|[code]

Example: GET [base]/HealthcareService?endpoint.connection-type=http://hl7.org.au/fhir/CodeSystem/smd-interfaces|http://ns.electronichealth.net.au/smd/intf/SealedMessageDelivery/TLS/2010

Support:

  • MUST support search by HealthcareService by endpoint connection type.

Implementation Notes: (how to search by token)


Search: Payload Type (Service Category)

Chained search (via Endpoint) based on token for the type of content supported by the endpoint.

GET [base]/HealthcareService?endpoint.payload-type=[system]|[code]

Example: GET [base]/HealthcareService?endpoint.payload-type=http://hl7.org.au/fhir/CodeSystem/smd-interfaces|http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706

Support:

  • MUST support search HealthcareService by endpoint payload type.

Implementation Notes: (how to search by token)


Search: Active Practitioner Role by Identifier Exists

Reverse chained search _has argument based on token to ensure practitioner role with a specific identifier is active and is referring to this service.

This uses existing search parameters on PractitionerRole search capability where PractitionerRole.healthcareService is referencing the subject healthcare service.

GET [base]/HealthcareService?_has:PractitionerRole:service:identifier=[system]|[value]&_has:PractitionerRole:service:active=[status]

Example: GET [base]/HealthcareService?_has:PractitionerRole:service:identifier=http://ns.electronichealth.net.au/id/medicare-provider-number|444455AA&_has:PractitionerRole:service:active=true

Support:

  • MAY support search HealthcareService for existence of active practitioner role with specific identifier.

Implementation Notes: (how to search by token), (how to check for existence of referring resource)


Search: Include References

The _include argument allows the automatic inclusion of referenced resources in the response for a search; based on search parameters defined for this resource type1.

Example: GET [base]/HealthcareService?_include=HealthcareService:organization&_include=HealthcareService:endpoint&_include=HealthcareService:location

Support:

  • MUST support _include HealthcareService references location (Location), organization (Organization), endpoint (Endpoint).

Search: Combination

  • Searches MUST be able to be perfomed in a single request using logical AND for criteria. e.g specialty cardiologist in post code 4846