Australian Profile for Provider Directory Services

This page is part of the Australian Provider Directory IG (v0.3.0: PD 1 on FHIR STU3 Draft) based on FHIR R3. The current version which supercedes this version is 2.0.1. For a full list of available versions, see the Directory of published versions

SD.9 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.

Examples

Healthcare Service Directory Entry Example

SD.9.1 Formal Views of Profile Content

The official URL for this profile is: 

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

Australian healthcare service provider directory directory entry

This profile builds on AU Base Healthcare Service.

This profile was published on Fri Jun 09 16:54:42 AEST 2017 as a draft by null.

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

Australian Healthcare Service Directory Entry

  1. Must Support Required: Organisation (Reference)
  2. Must Support Required: Location (Reference)
  3. Must Support Required: Service Name (string)
  4. Must Support 1..*: Specialty (Coding)
  5. Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
  6. Must Support 0 or more: Endpoint, secure messaging or others (Reference)
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*Healthcare Service Directory Entry
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier SI0..1IdentifierHPI-O
inv-hpio-0: HPI-O is exactly 16 characters
inv-hpio-1: HPI-O prefix is 800362
.... type 1..1CodeableConceptHPI-O Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 0..1CodingHPI-O Identifier Type Code
Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI","display":"National Organisation Identifier"}
..... text 1..1stringHPI-O Identifier Type Descriptive Text
Fixed Value: HPI-O
.... system 1..1uriNamespace uri for HPI-O values
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value 1..1stringExample HPI-O number': 8003627500000328
Max Length: 16
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
... identifier S0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
.... type 1..1CodeableConceptVendor Directory Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingVendor Directory Identifier
Fixed Value: {"code":"VDI","display":"Vendor Directory Identifier"}
..... 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)
..... display 1..1string
.... au-assigningauthority S0..1(Complex)Optional Extensions Element
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
... providedBy 1..1Reference(AU PD Organisation)
... specialty SCodeableConceptSlice: Unordered, Open by value:coding.system
... specialty 0..*CodeableConceptBinding: Healthcare Service Role (ANZSCO based) Valueset (required)
... specialty 0..*CodeableConceptBinding: Healthcare Service Specialties (required)
... location 1..*Reference(AU PD Location)
... name S1..1string
... telecom S0..*ContactPoint
... endpoint S0..*Reference(Endpoint), Reference(AU PD Secure Messaging Endpoint)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*Healthcare Service Directory Entry
... 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 0..*(Complex)Extension
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierExternal identifiers for this item
Slice: Unordered, Open by value:system, value:type
... identifier SΣI0..1IdentifierHPI-O
inv-hpio-0: HPI-O is exactly 16 characters
inv-hpio-1: HPI-O prefix is 800362
.... id 0..1stringxml:id (or equivalent in JSON)
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id-type"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptHPI-O Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingHPI-O Identifier Type Code

Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI","display":"National Organisation Identifier"}
..... text Σ1..1stringHPI-O Identifier Type Descriptive Text
Fixed Value: HPI-O
.... system Σ1..1uriNamespace uri for HPI-O values
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value Σ1..1stringThe value that is unique
Example General': 123456
Example HPI-O number': 8003627500000328
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)
... identifier SΣ0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... au-assigningauthority S0..1(Complex)Optional Extensions Element
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id-type"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptVendor Directory Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingVendor Directory Identifier

Fixed Value: {"code":"VDI","display":"Vendor Directory Identifier"}
..... text Σ1..1stringVendor Directory Identifier Type
Fixed Value: Vendor Directory Identifier
.... system Σ1..1uriVendor allocated URL
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringVendor Identifier Value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringxml:id (or equivalent in JSON)
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ1..1stringText alternative for the resource
... active ?!Σ0..1booleanWhether this healthcareservice is in active use
... providedBy Σ1..1Reference(AU PD 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 SΣCodeableConceptSpecialties handled by the HealthcareService
Slice: Unordered, Open by value:coding.system
Binding: Practice Setting Code Value Set (preferred)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Healthcare Service Role (ANZSCO based) Valueset (required)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Healthcare Service Specialties (required)
... location Σ1..*Reference(AU PD Location)Location(s) where service may be provided
... name SΣ1..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 S0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(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 S0..*Reference(Endpoint), Reference(AU PD Secure Messaging Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Australian Healthcare Service Directory Entry

  1. Must Support Required: Organisation (Reference)
  2. Must Support Required: Location (Reference)
  3. Must Support Required: Service Name (string)
  4. Must Support 1..*: Specialty (Coding)
  5. Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
  6. Must Support 0 or more: Endpoint, secure messaging or others (Reference)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*Healthcare Service Directory Entry
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier SI0..1IdentifierHPI-O
inv-hpio-0: HPI-O is exactly 16 characters
inv-hpio-1: HPI-O prefix is 800362
.... type 1..1CodeableConceptHPI-O Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 0..1CodingHPI-O Identifier Type Code
Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI","display":"National Organisation Identifier"}
..... text 1..1stringHPI-O Identifier Type Descriptive Text
Fixed Value: HPI-O
.... system 1..1uriNamespace uri for HPI-O values
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value 1..1stringExample HPI-O number': 8003627500000328
Max Length: 16
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
... identifier S0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
.... type 1..1CodeableConceptVendor Directory Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 1..1CodingVendor Directory Identifier
Fixed Value: {"code":"VDI","display":"Vendor Directory Identifier"}
..... 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)
..... display 1..1string
.... au-assigningauthority S0..1(Complex)Optional Extensions Element
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
... providedBy 1..1Reference(AU PD Organisation)
... specialty SCodeableConceptSlice: Unordered, Open by value:coding.system
... specialty 0..*CodeableConceptBinding: Healthcare Service Role (ANZSCO based) Valueset (required)
... specialty 0..*CodeableConceptBinding: Healthcare Service Specialties (required)
... location 1..*Reference(AU PD Location)
... name S1..1string
... telecom S0..*ContactPoint
... endpoint S0..*Reference(Endpoint), Reference(AU PD Secure Messaging Endpoint)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*Healthcare Service Directory Entry
... 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 0..*(Complex)Extension
URL: http://hl7.org.au/fhir/StructureDefinition/healthcareservice-eligibility-detail
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierExternal identifiers for this item
Slice: Unordered, Open by value:system, value:type
... identifier SΣI0..1IdentifierHPI-O
inv-hpio-0: HPI-O is exactly 16 characters
inv-hpio-1: HPI-O prefix is 800362
.... id 0..1stringxml:id (or equivalent in JSON)
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 routing content
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id-type"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptHPI-O Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingHPI-O Identifier Type Code

Fixed Value: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI","display":"National Organisation Identifier"}
..... text Σ1..1stringHPI-O Identifier Type Descriptive Text
Fixed Value: HPI-O
.... system Σ1..1uriNamespace uri for HPI-O values
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value Σ1..1stringThe value that is unique
Example General': 123456
Example HPI-O number': 8003627500000328
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)
... identifier SΣ0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... au-assigningauthority S0..1(Complex)Optional Extensions Element
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"universal-id-type"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority"
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptVendor Directory Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ1..1CodingVendor Directory Identifier

Fixed Value: {"code":"VDI","display":"Vendor Directory Identifier"}
..... text Σ1..1stringVendor Directory Identifier Type
Fixed Value: Vendor Directory Identifier
.... system Σ1..1uriVendor allocated URL
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ1..1stringVendor Identifier Value
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ1..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringxml:id (or equivalent in JSON)
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ1..1stringText alternative for the resource
... active ?!Σ0..1booleanWhether this healthcareservice is in active use
... providedBy Σ1..1Reference(AU PD 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 SΣCodeableConceptSpecialties handled by the HealthcareService
Slice: Unordered, Open by value:coding.system
Binding: Practice Setting Code Value Set (preferred)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Healthcare Service Role (ANZSCO based) Valueset (required)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Healthcare Service Specialties (required)
... location Σ1..*Reference(AU PD Location)Location(s) where service may be provided
... name SΣ1..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 S0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(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 S0..*Reference(Endpoint), Reference(AU PD Secure Messaging Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

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

 

SD.9.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: 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 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|3471000175103

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]|[code]

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.

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

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

Support:

  • SHOULD 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)

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

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

Example: GET [base]/HealthcareService?endpoint.connection-type=http://hl7.org.au.fhir/ValueSet/au-serviceinterfaces|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)

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

GET [base]/HealthcareService?endpint.payload-type=[system]|[value]

Example: GET [base]/HealthcareService?endpoint.payload-type=http://hl7.org.au.fhir/ValueSet/valueset-au-endpoint-payload-type|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: 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 type.

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

Support:

  • MUST support _include HealthcareService references location, organization, 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