Australian Provider Directory Implementation Guide (PD 1)

This page is part of the Australian Provider Directory IG (v1.0.0: PD 1 on FHIR STU3) 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.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.

Examples

Healthcare Service Directory Entry Example

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

Australian healthcare service provider directory directory entry

This profile builds on AUBaseHealthcareService.

This profile was published on Tue May 14 00:00:00 AEST 2019 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 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: Specialties (Coding)
  7. Must Support Required: Location (Reference)
  8. Must Support Required: Service Name (string)
  9. Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
  10. Must Support 0 or more: Endpoints, secure messaging or others (Reference)
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*Healthcare Service Directory Entry
... meta 0..1MetaMetadata about the resource (extended)
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... meta-source S0..*uriPreadopt STU4 Meta.source
URL: http://hl7.org.au/fhir/StructureDefinition/meta-source
... identifier 0..*IdentifierDirectory entry healthcare service identifiers
... identifier S0..*Identifier
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
.... type 0..1CodeableConceptHPI-O Identifier Type
..... coding 1..*Coding
..... text 0..1stringHPI-O Identifier Type Descriptive Text
... identifier S0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
.... type 1..1CodeableConceptVendor Directory Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
..... coding 1..1CodingVendor Directory Identifier
...... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
...... code 1..1codeFixed 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
... 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
... endpoint S0..*Reference(Endpoint | AU PD Secure Messaging Endpoint)Technical endpoints for this healthcare service, including secure messaging endpoints

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 (extended)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... meta-source S0..*uriPreadopt STU4 Meta.source
URL: http://hl7.org.au/fhir/StructureDefinition/meta-source
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/meta-source"
..... valueUri 1..1uriSource System URI
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: Common Tags (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... healthcareservice-eligibility-detail I0..*(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://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierDirectory entry healthcare service identifiers
Slice: Unordered, Open by pattern:type, value:system
... identifier SΣI0..*IdentifierHealthcare Provider Identifier – Organisation (HPI-O)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension 0..1ExtensionApplication Identifier
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionUniversal Identifier Value
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionType Scheme of universal-id
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... 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 Σ0..1CodeableConceptHPI-O Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
..... text Σ0..1stringHPI-O Identifier Type Descriptive Text
Fixed Value: HPI-O
.... system Σ1..1uriNamespace for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value Σ1..1stringHPI-O number
Example General': 123456
Example HPI-O number': 8003621566684455
Max Length: 16
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier SΣ0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension 0..1ExtensionApplication Identifier
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionUniversal Identifier Value
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionType Scheme of universal-id
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... 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 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..1CodingVendor Directory Identifier
...... 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: 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 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)Secure messaging vendor organisation
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... 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..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Σ0..*CodeableConceptDirectory SNOMED-CT specialties offered by the HealthcareService
Binding: Healthcare Service Roles (SNOMED) (preferred)
... 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..1stringExtra 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 inteded for/available to
... serviceProvisionCode 0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..1CodeableConceptPrimary eligibility criteria for service
Binding: (unbound) (example)
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that categorize the service
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example)
... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Endpoint | AU PD Secure Messaging Endpoint)Technical endpoints for this healthcare service, including secure messaging endpoints

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: Specialties (Coding)
  7. Must Support Required: Location (Reference)
  8. Must Support Required: Service Name (string)
  9. Must Support 0 or more: Contact Details - phone, fax, email etc. (ContactPoint)
  10. Must Support 0 or more: Endpoints, secure messaging or others (Reference)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*Healthcare Service Directory Entry
... meta 0..1MetaMetadata about the resource (extended)
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... meta-source S0..*uriPreadopt STU4 Meta.source
URL: http://hl7.org.au/fhir/StructureDefinition/meta-source
... identifier 0..*IdentifierDirectory entry healthcare service identifiers
... identifier S0..*Identifier
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
.... type 0..1CodeableConceptHPI-O Identifier Type
..... coding 1..*Coding
..... text 0..1stringHPI-O Identifier Type Descriptive Text
... identifier S0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
.... type 1..1CodeableConceptVendor Directory Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
..... coding 1..1CodingVendor Directory Identifier
...... system 1..1uriFixed Value: http://hl7.org.au/fhir/v2/0203
...... code 1..1codeFixed 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
... 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
... endpoint S0..*Reference(Endpoint | AU PD Secure Messaging Endpoint)Technical endpoints for this healthcare service, including secure messaging endpoints

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 (extended)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... meta-source S0..*uriPreadopt STU4 Meta.source
URL: http://hl7.org.au/fhir/StructureDefinition/meta-source
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/meta-source"
..... valueUri 1..1uriSource System URI
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: Common Tags (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... healthcareservice-eligibility-detail I0..*(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://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIdentifierDirectory entry healthcare service identifiers
Slice: Unordered, Open by pattern:type, value:system
... identifier SΣI0..*IdentifierHealthcare Provider Identifier – Organisation (HPI-O)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension 0..1ExtensionApplication Identifier
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionUniversal Identifier Value
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionType Scheme of universal-id
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... 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 Σ0..1CodeableConceptHPI-O Identifier Type
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI"}]}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
..... text Σ0..1stringHPI-O Identifier Type Descriptive Text
Fixed Value: HPI-O
.... system Σ1..1uriNamespace for HPI-O
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
.... value Σ1..1stringHPI-O number
Example General': 123456
Example HPI-O number': 8003621566684455
Max Length: 16
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier SΣ0..*IdentifierSecure Messaging Vendor's Healthcare Service Identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... au-assigningauthority S0..1(Complex)Optional HL7 V2 Assigning Authority
URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension 0..1ExtensionApplication Identifier
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"namespace-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionUniversal Identifier Value
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"universal-id"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionType Scheme of universal-id
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... 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 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..1CodingVendor Directory Identifier
...... 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: 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 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)Secure messaging vendor organisation
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... 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..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Σ0..*CodeableConceptDirectory SNOMED-CT specialties offered by the HealthcareService
Binding: Healthcare Service Roles (SNOMED) (preferred)
... 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..1stringExtra 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 inteded for/available to
... serviceProvisionCode 0..*CodeableConceptHealthcare service provision conditions
Binding: Service Provision Conditions Australian Concepts (preferred)
... eligibility 0..1CodeableConceptPrimary eligibility criteria for service
Binding: (unbound) (example)
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that categorize the service
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example)
... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(Endpoint | AU PD Secure Messaging Endpoint)Technical endpoints for this healthcare service, including secure messaging endpoints

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