AU Core Implementation Guide
0.2.2-preview - Preview
AU Core Implementation Guide
0.2.2-preview - Preview
This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-healthcareservice | Version: 0.2.2-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreHealthcareService | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a HealthcareService resource to record, search, and fetch information about a healthcare service. It is based on the AU Base Healthcare Service profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the HealthcareService when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
No equivalent International Patient Access, International Patient Summary, or US Core profile.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseHealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HealthcareService | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context | |
  Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type |
   identifier:hpio | S | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) |
  active | 0..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true | |
 providedBy | S | 0..1 | Reference(AU Core Organization) | Organization that provides this service |
| category | S | 0..* | CodeableConcept | Broad category of service being performed or delivered |
| type | S | 0..* | CodeableConcept | Type of service that may be delivered or performed |
| specialty | S | 0..* | CodeableConcept | Specialties handled by the HealthcareService |
| location | S | 0..* | Reference(AU Core Location) | Location(s) where service may be provided |
| name | S | 1..1 | string | Description of service as presented to a consumer while searching |
 serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.serviceProvisionCode | extensible | ServiceProvisionConditionsAustralianConcepts |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type |
| identifier:hpio | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) |
| active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true |
| providedBy | SΣ | 0..1 | Reference(AU Core Organization) | Organization that provides this service |
 category | SΣ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. |
| type | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (preferred) |
| specialty | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred) |
| location | SΣ | 0..* | Reference(AU Core Location) | Location(s) where service may be provided |
| name | SΣ | 1..1 | string | Description of service as presented to a consumer while searching |
| serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.category | example | ServiceCategory |
| HealthcareService.type | preferred | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 |
| HealthcareService.specialty | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 |
| HealthcareService.serviceProvisionCode | extensible | ServiceProvisionConditionsAustralianConcepts |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type | ||||
| identifier:hpio | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) | ||||
| active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true | ||||
| providedBy | SΣ | 0..1 | Reference(AU Core Organization) | Organization that provides this service | ||||
| category | SΣ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
| type | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (preferred) | ||||
| specialty | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred) | ||||
| location | SΣ | 0..* | Reference(AU Core Location) | Location(s) where service may be provided | ||||
| name | SΣ | 1..1 | string | Description of service as presented to a consumer while searching | ||||
| comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails | 0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
| telecom | 0..* | ContactPoint | Contacts related to the healthcare service | |||||
| coverageArea | 0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (extensible) | ||||
| eligibility | 0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available. | |||||
| comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| communication | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. | |||||
| appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |||||
| availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| timeZone | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
| value | 0..1 | time | Primitive value for time | |||||
 availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
 id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| timeZone | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
| value | 0..1 | time | Primitive value for time | |||||
| notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
| during | 0..1 | Period | Service not available from this date | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| HealthcareService.language | preferred | CommonLanguages
| ||||
| HealthcareService.category | example | ServiceCategory | ||||
| HealthcareService.type | preferred | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
| HealthcareService.specialty | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
| HealthcareService.serviceProvisionCode | extensible | ServiceProvisionConditionsAustralianConcepts | ||||
| HealthcareService.eligibility.code | example | |||||
| HealthcareService.program | example | Program | ||||
| HealthcareService.characteristic | example | |||||
| HealthcareService.communication | preferred | CommonLanguages
| ||||
| HealthcareService.referralMethod | example | ReferralMethod | ||||
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
This structure is derived from AUBaseHealthcareService
Summary
Mandatory: 1 element
Must-Support: 9 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from AUBaseHealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context | |
| Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type |
| identifier:hpio | S | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) |
| active | 0..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true | |
| providedBy | S | 0..1 | Reference(AU Core Organization) | Organization that provides this service |
| category | S | 0..* | CodeableConcept | Broad category of service being performed or delivered |
| type | S | 0..* | CodeableConcept | Type of service that may be delivered or performed |
| specialty | S | 0..* | CodeableConcept | Specialties handled by the HealthcareService |
| location | S | 0..* | Reference(AU Core Location) | Location(s) where service may be provided |
| name | S | 1..1 | string | Description of service as presented to a consumer while searching |
| serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.serviceProvisionCode | extensible | ServiceProvisionConditionsAustralianConcepts |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type |
| identifier:hpio | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) |
| active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true |
| providedBy | SΣ | 0..1 | Reference(AU Core Organization) | Organization that provides this service |
| category | SΣ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. |
| type | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (preferred) |
| specialty | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred) |
| location | SΣ | 0..* | Reference(AU Core Location) | Location(s) where service may be provided |
| name | SΣ | 1..1 | string | Description of service as presented to a consumer while searching |
| serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.category | example | ServiceCategory |
| HealthcareService.type | preferred | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 |
| HealthcareService.specialty | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 |
| HealthcareService.serviceProvisionCode | extensible | ServiceProvisionConditionsAustralianConcepts |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService | 0..* | AUBaseHealthcareService | A healthcare service in an Australian healthcare context | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | S | 0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item Slice: Unordered, Open by pattern:type | ||||
| identifier:hpio | SC | 0..1 | AUHPIO | Healthcare Provider Identifier – Organisation (HPI-O) | ||||
| active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true | ||||
| providedBy | SΣ | 0..1 | Reference(AU Core Organization) | Organization that provides this service | ||||
| category | SΣ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
| type | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (preferred) | ||||
| specialty | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred) | ||||
| location | SΣ | 0..* | Reference(AU Core Location) | Location(s) where service may be provided | ||||
| name | SΣ | 1..1 | string | Description of service as presented to a consumer while searching | ||||
| comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails | 0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
| telecom | 0..* | ContactPoint | Contacts related to the healthcare service | |||||
| coverageArea | 0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (extensible) | ||||
| eligibility | 0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available. | |||||
| comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| communication | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. | |||||
| appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |||||
| availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| timeZone | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
| value | 0..1 | time | Primitive value for time | |||||
| availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| timeZone | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |||||
| value | 0..1 | time | Primitive value for time | |||||
| notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
| during | 0..1 | Period | Service not available from this date | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| HealthcareService.language | preferred | CommonLanguages
| ||||
| HealthcareService.category | example | ServiceCategory | ||||
| HealthcareService.type | preferred | https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
| HealthcareService.specialty | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
| HealthcareService.serviceProvisionCode | extensible | ServiceProvisionConditionsAustralianConcepts | ||||
| HealthcareService.eligibility.code | example | |||||
| HealthcareService.program | example | Program | ||||
| HealthcareService.characteristic | example | |||||
| HealthcareService.communication | preferred | CommonLanguages
| ||||
| HealthcareService.referralMethod | example | ReferralMethod | ||||
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
This structure is derived from AUBaseHealthcareService
Summary
Mandatory: 1 element
Must-Support: 9 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| name | SHALL | string |
|
| service-category | SHOULD | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| identifier | SHOULD | token |
The client SHALL provide at least a code value and SHOULD provide both the system and code values. The server SHALL support both. The client SHOULD support search using HPI-O identifier as defined in the profile. The server SHOULD support search using the using HPI-O identifier as defined in the profile. |
| location | SHOULD | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
| organization | SHOULD | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
| specialty | SHOULD | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| service-type | SHOULD | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
The following search parameters and search parameter combinations SHALL be supported:
name search parameter:
_revinclude parameters: Provenance:targetGET [base]/HealthcareService?name=[string]
Example:
Implementation Notes: Fetches a bundle of all HealthcareService resources matching the name (how to search by string)
The following search parameters and search parameter combinations SHOULD be supported:
service-category search parameters:
_revinclude parameters: Provenance:targetGET [base]/HealthcareService?service-category={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all HealthcareService resources for the specified service category (how to search by token)
identifier search parameter:
_revinclude parameters: Provenance:targetGET [base]/HealthcareService?identifier={system|}[code]
Example:
Implementation Notes: Fetches a bundle containing any Practitioner resources matching the identifier (how to search by token)
location search parameters:
_revinclude parameters: Provenance:targetGET [base]/HealthcareService?location={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all HealthcareService resources matching the specified location (how to search by reference)
organization search parameters:
_revinclude parameters: Provenance:targetGET [base]/HealthcareService?organization={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all HealthcareService resources matching the specified organisation (how to search by reference)
specialty search parameters:
_revinclude parameters: Provenance:targetGET [base]/HealthcareService?specialty={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all HealthcareService resources for the specified specialty (how to search by token)
service-type search parameters:
_revinclude parameters: Provenance:targetGET [base]/HealthcareService?service-type={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all HealthcareService resources for the specified type (how to search by token)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.2.2-preview based on FHIR 4.0.1. Generated 2023-11-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change