AU Core Implementation Guide
1.1.0-ci-build - CI Build Australia flag

AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/mjosborne1/mjo-au-fhir-core/ and changes regularly. See the Directory of published versions

Resource Profile: AU Core HealthcareService

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-healthcareservice Version: 1.1.0-ci-build
Standards status: Trial-use 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 HealthcareService profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the HealthcareService resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for basic information about a healthcare service by identifier, type or name
  • Record or update basic information for a healthcare service
  • Read information about a healthcare service referenced by another resource

Profile specific implementation guidance

  • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.

Usages:

Changes since version 1.0.0:

  • New Content

    • Formal Views of Profile Content

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

    This structure is derived from AUBaseHealthcareService

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. HealthcareService 0..* AUBaseHealthcareService A healthcare service in an Australian healthcare context
    ... identifier SO 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... type SO 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type . (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SO 1..1 string Description of service as presented to a consumer while searching
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    HealthcareService.typeextensibleServiceType .
    https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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
    ... identifier SOΣ 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... type SOΣ 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type . (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SOΣ 1..1 string Description of service as presented to a consumer while searching
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... telecom SO 0..* ContactPoint Contacts related to the healthcare service
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    HealthcareService.typeextensibleServiceType .
    https://healthterminologies.gov.au/fhir/ValueSet/service-type-1

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorHealthcareServiceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceHealthcareServiceA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier SOΣ 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
    ... providedBy Σ 0..1 Reference(Organization) Organization that provides this service
    ... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
    Binding: ServiceCategory (example): A category of the service(s) that could be provided.
    ... type SOΣ 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type . (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
    Binding: Clinical Specialty . (preferred)
    ... location Σ 0..* Reference(Location) Location(s) where service may be provided
    ... name SOΣ 1..1 string Description of service as presented to a consumer while searching
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... 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 SO 0..* ContactPoint Contacts related to the healthcare service
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
    ... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
    Binding: Service Provision Conditions Australian Concepts (preferred)
    ... 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 Description: (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 Description: (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: Common Languages in Australia . (extensible)
    ... 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
    ...... extension: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
    ...... extension: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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    HealthcareService.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    From the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    HealthcareService.categoryexampleServiceCategory
    http://hl7.org/fhir/ValueSet/service-category
    From the FHIR Standard
    HealthcareService.typeextensibleServiceType .
    https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
    HealthcareService.specialtypreferredClinicalSpecialty .
    https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
    HealthcareService.serviceProvisionCodepreferredServiceProvisionConditionsAustralianConcepts
    http://terminology.hl7.org.au/ValueSet/service-provision-conditions
    HealthcareService.eligibility.codeexample
    HealthcareService.programexampleProgram
    http://hl7.org/fhir/ValueSet/program
    From the FHIR Standard
    HealthcareService.characteristicexample
    HealthcareService.communicationextensibleCommonLanguagesInAustralia .
    https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
    HealthcareService.referralMethodexampleReferralMethod
    http://hl7.org/fhir/ValueSet/service-referral-method
    From the FHIR Standard
    HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek
    http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
    From the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorHealthcareServiceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceHealthcareServiceA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from AUBaseHealthcareService

    Summary

    Mandatory: 1 element
    Must-Support: 4 elements

    Maturity: 0

    Differential View

    This structure is derived from AUBaseHealthcareService

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. HealthcareService 0..* AUBaseHealthcareService A healthcare service in an Australian healthcare context
    ... identifier SO 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... type SO 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type . (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SO 1..1 string Description of service as presented to a consumer while searching
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    HealthcareService.typeextensibleServiceType .
    https://healthterminologies.gov.au/fhir/ValueSet/service-type-1

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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
    ... identifier SOΣ 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... type SOΣ 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type . (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... name SOΣ 1..1 string Description of service as presented to a consumer while searching
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... telecom SO 0..* ContactPoint Contacts related to the healthcare service
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    HealthcareService.typeextensibleServiceType .
    https://healthterminologies.gov.au/fhir/ValueSet/service-type-1

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorHealthcareServiceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceHealthcareServiceA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier SOΣ 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
    ... providedBy Σ 0..1 Reference(Organization) Organization that provides this service
    ... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
    Binding: ServiceCategory (example): A category of the service(s) that could be provided.
    ... type SOΣ 0..* CodeableConcept Type of service that may be delivered or performed
    Binding: Service Type . (extensible)
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
    Binding: Clinical Specialty . (preferred)
    ... location Σ 0..* Reference(Location) Location(s) where service may be provided
    ... name SOΣ 1..1 string Description of service as presented to a consumer while searching
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... 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 SO 0..* ContactPoint Contacts related to the healthcare service
    ObligationsActor
    SHALL:populate-if-known AU Core Responder
    SHALL:no-error AU Core Requester
    ... coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
    ... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
    Binding: Service Provision Conditions Australian Concepts (preferred)
    ... 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 Description: (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 Description: (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: Common Languages in Australia . (extensible)
    ... 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
    ...... extension: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
    ...... extension: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

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    HealthcareService.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    From the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    HealthcareService.categoryexampleServiceCategory
    http://hl7.org/fhir/ValueSet/service-category
    From the FHIR Standard
    HealthcareService.typeextensibleServiceType .
    https://healthterminologies.gov.au/fhir/ValueSet/service-type-1
    HealthcareService.specialtypreferredClinicalSpecialty .
    https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
    HealthcareService.serviceProvisionCodepreferredServiceProvisionConditionsAustralianConcepts
    http://terminology.hl7.org.au/ValueSet/service-provision-conditions
    HealthcareService.eligibility.codeexample
    HealthcareService.programexampleProgram
    http://hl7.org/fhir/ValueSet/program
    From the FHIR Standard
    HealthcareService.characteristicexample
    HealthcareService.communicationextensibleCommonLanguagesInAustralia .
    https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2
    HealthcareService.referralMethodexampleReferralMethod
    http://hl7.org/fhir/ValueSet/service-referral-method
    From the FHIR Standard
    HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek
    http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
    From the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorHealthcareServiceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
    dom-4errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    dom-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
    : contained.meta.security.empty()
    dom-6best practiceHealthcareServiceA resource should have narrative for robust management
    : text.`div`.exists()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    This structure is derived from AUBaseHealthcareService

    Summary

    Mandatory: 1 element
    Must-Support: 4 elements

    Maturity: 0

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:

    Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.

    FHIR search operations are described here and the syntax used to describe AU Core interactions is defined 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
    identifier SHOULD token The requester SHALL provide both the system and code values. The responder SHALL support both.
    _id SHOULD token
    service-type SHOULD token The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both.

    Mandatory Search Parameters

    The following search parameters SHALL be supported:

    1. SHALL support searching using the name search parameter:

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

      Example:

      1. GET [base]/HealthcareService?name=Albion%20Hospital%20Radiology%20Service

      Implementation Notes: Fetches a bundle containing all HealthcareService resources matching the name (how to search by string)

    Optional Search Parameters:

    The following search parameters SHOULD be supported:

    1. SHOULD support searching using the identifier search parameter:

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

      Example:

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

      Implementation Notes: Fetches a bundle containing all HealthcareService resources matching the identifier (how to search by token)

    2. SHOULD support searching using the _id search parameter:

      GET [base]/HealthcareService?_id=[id]

      Example:

      1. GET [base]/HealthcareService?_id=214466

      Implementation Notes: Fetches a bundle with the requested HealthcareService, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)

    3. SHOULD support searching using the service-type search parameter:

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

      Example:

      1. GET [base]/HealthcareService?service-type=http://snomed.info/sct|1223451000168109
      2. GET [base]/HealthcareService?service-type=1223451000168109

      Implementation Notes: Fetches a bundle containing all HealthcareService resources matching the specified service type (how to search by token)