MediRecords FHIR Implementation Guide
1.4.1 - release


Resource Profile: MR HealthcareService

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-healthcare-service-core
Version:1.4.1
Name:MRHealthcareService
Title:MR HealthcareService
Status:Active as of 2025-02-03 04:29:41+0000
Definition:

MediRecords core HealthcareService profile

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://fhir.medirecords.com/StructureDefinition/mr-healthcare-service-core

Formal Views of Profile Content

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

This structure is derived from AUBaseHealthcareService

Summary

Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 12 elements

Structures

This structure refers to these other structures:

This structure is derived from AUBaseHealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..* AUBaseHealthcareService A healthcare service in an Australian healthcare context
... meta
.... lastUpdated S 0..1 instant When the resource version last changed
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier S 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
... active S 1..1 boolean Whether this HealthcareService record is in active use
... type S 0..* CodeableConcept Type of service that may be delivered or performed
... specialty S 0..* CodeableConcept Specialties handled by the HealthcareService
... location S 1..1 Reference(Location) Location(s) where service may be provided
... name S 1..1 string Description of service as presented to a consumer while searching
... telecom S 0..* ContactPoint Contacts related to the healthcare service
... serviceProvisionCode S 0..* CodeableConcept Conditions under which service is available/offered
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
... active ?!SΣ 1..1 boolean Whether this HealthcareService record is in active use
... providedBy SΣ 1..1 Reference(MR Organisation) 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 SΣ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: Service Type . (preferred)
... specialty SΣ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: Clinical Specialty . (preferred)
... location SΣ 1..1 Reference(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 S 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 (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 (No ValueSet): (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 (No ValueSet): (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.

Additional BindingsPurpose
AllLanguages Max Binding

... 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 S 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..* AUBaseHealthcareService A healthcare service in an Australian healthcare context
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
... active ?!Σ 1..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)
... location Σ 1..1 Reference(Location) Location(s) where service may be provided
... name Σ 1..1 string Description of service as presented to a consumer while searching
... telecom 0..* ContactPoint Contacts related to the healthcare service
... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: Service Provision Conditions Australian Concepts (preferred)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

This structure is derived from AUBaseHealthcareService

Summary

Mandatory: 4 elements(1 nested mandatory element)
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from AUBaseHealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..* AUBaseHealthcareService A healthcare service in an Australian healthcare context
... meta
.... lastUpdated S 0..1 instant When the resource version last changed
.... profile S 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier S 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
... active S 1..1 boolean Whether this HealthcareService record is in active use
... type S 0..* CodeableConcept Type of service that may be delivered or performed
... specialty S 0..* CodeableConcept Specialties handled by the HealthcareService
... location S 1..1 Reference(Location) Location(s) where service may be provided
... name S 1..1 string Description of service as presented to a consumer while searching
... telecom S 0..* ContactPoint Contacts related to the healthcare service
... serviceProvisionCode S 0..* CodeableConcept Conditions under which service is available/offered
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier, AUHPIO, AUResidentialAgedCareServiceIdentifier External identifiers for this item
... active ?!SΣ 1..1 boolean Whether this HealthcareService record is in active use
... providedBy SΣ 1..1 Reference(MR Organisation) 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 SΣ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: Service Type . (preferred)
... specialty SΣ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: Clinical Specialty . (preferred)
... location SΣ 1..1 Reference(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 S 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 (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 (No ValueSet): (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 (No ValueSet): (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.

Additional BindingsPurpose
AllLanguages Max Binding

... 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 S 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
HealthcareService.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
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.typepreferredServiceType .
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.communicationpreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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()