AU Base Implementation Guide
4.2.1-ci-build - CI Build
AU Base Implementation Guide
4.2.1-ci-build - CI Build
AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 4.2.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/StructureDefinition/au-healthcareservice | Version: 4.2.1-ci-build | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: AUBaseHealthcareService | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile defines a healthcare service structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.
Profile specific implementation guidance:
HealthcareService.identifier when supporting the case where network HPI-Os are issued for sub-organisations, departments, or other logical divisions acting as specific healthcare services. This is useful in the absence of any specific national identifier for healthcare service entities.HealthcareService.telecomHealthcareService.telecom.extensionPotentially useful extensions:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HealthcareService |
0..* | HealthcareService | A healthcare service in an Australian healthcare context | |
  identifier |
0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item | |
 type |
0..* | CodeableConcept | Type of service that may be delivered or performed Binding: Service Type  (preferred) | |
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred) | |
| serviceProvisionCode |
0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (preferred) | |
 availableTime |
||||
  availableStartTime |
||||
   timeZone |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |
| availableEndTime |
||||
| timeZone |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | preferred | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
| HealthcareService.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | |
| HealthcareService.serviceProvisionCode | preferred | ServiceProvisionConditionsAustralianConcepts (a valid code from Service Provision Conditions Australian Concepts)http://terminology.hl7.org.au/ValueSet/service-provision-conditionsfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | 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 |
0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item | |
| active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
| type |
Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: Service Type (preferred) |
| specialty |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred) |
| serviceProvisionCode |
0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | preferred | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
| HealthcareService.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | |
| HealthcareService.serviceProvisionCode | preferred | ServiceProvisionConditionsAustralianConcepts (a valid code from Service Provision Conditions Australian Concepts)http://terminology.hl7.org.au/ValueSet/service-provision-conditionsfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | HealthcareService | If 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-4 | error | HealthcareService | If 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-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | 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 | ||||
| identifier |
0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item | |||||
| 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 |
Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: Service Type (preferred) | ||||
| specialty |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred) | ||||
| location |
Σ | 0..* | Reference(Location) | Location(s) where service may be provided | ||||
| name |
Σ | 0..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 |
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: (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 | URI | |||
| HealthcareService.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | ||||
| HealthcareService.type | preferred | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
| HealthcareService.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
| HealthcareService.serviceProvisionCode | preferred | ServiceProvisionConditionsAustralianConcepts (a valid code from Service Provision Conditions Australian Concepts)http://terminology.hl7.org.au/ValueSet/service-provision-conditionsfrom this IG | ||||
| HealthcareService.eligibility.code | example | |||||
| HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/programfrom the FHIR Standard | ||||
| HealthcareService.characteristic | example | |||||
| HealthcareService.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-methodfrom the FHIR Standard | ||||
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | HealthcareService | If 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-4 | error | HealthcareService | If 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-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from HealthcareService
Differential View
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | A healthcare service in an Australian healthcare context | |
| identifier |
0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item | |
| type |
0..* | CodeableConcept | Type of service that may be delivered or performed Binding: Service Type (preferred) | |
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred) | |
| serviceProvisionCode |
0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (preferred) | |
| availableTime |
||||
| availableStartTime |
||||
| timeZone |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |
| availableEndTime |
||||
| timeZone |
0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | preferred | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
| HealthcareService.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | |
| HealthcareService.serviceProvisionCode | preferred | ServiceProvisionConditionsAustralianConcepts (a valid code from Service Provision Conditions Australian Concepts)http://terminology.hl7.org.au/ValueSet/service-provision-conditionsfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | 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 |
0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item | |
| active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
| type |
Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: Service Type (preferred) |
| specialty |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred) |
| serviceProvisionCode |
0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions Australian Concepts (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | preferred | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | |
| HealthcareService.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | |
| HealthcareService.serviceProvisionCode | preferred | ServiceProvisionConditionsAustralianConcepts (a valid code from Service Provision Conditions Australian Concepts)http://terminology.hl7.org.au/ValueSet/service-provision-conditionsfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | HealthcareService | If 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-4 | error | HealthcareService | If 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-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | 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 | ||||
| identifier |
0..* | Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier | External identifiers for this item | |||||
| 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 |
Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: Service Type (preferred) | ||||
| specialty |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Clinical Specialty (preferred) | ||||
| location |
Σ | 0..* | Reference(Location) | Location(s) where service may be provided | ||||
| name |
Σ | 0..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 |
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: (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 | URI | |||
| HealthcareService.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | ||||
| HealthcareService.type | preferred | ServiceType https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 | ||||
| HealthcareService.specialty | preferred | ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 | ||||
| HealthcareService.serviceProvisionCode | preferred | ServiceProvisionConditionsAustralianConcepts (a valid code from Service Provision Conditions Australian Concepts)http://terminology.hl7.org.au/ValueSet/service-provision-conditionsfrom this IG | ||||
| HealthcareService.eligibility.code | example | |||||
| HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/programfrom the FHIR Standard | ||||
| HealthcareService.characteristic | example | |||||
| HealthcareService.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-methodfrom the FHIR Standard | ||||
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | HealthcareService | If 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-4 | error | HealthcareService | If 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-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from HealthcareService
Other representations of profile: CSV, Excel, Schematron
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.2.1-ci-build based on FHIR 4.0.1. Generated 2024-05-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change