HealthcareService

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
containedC0..*Resource
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
identifierΣ C1..*IdentifierHCSACode
activeΣ ?!0..1boolean
providedByΣ C1..1Reference(Organization)
offeredInC0..0Reference(HealthcareService)
categoryΣ0..*CodeableConcept
typeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
locationΣ C0..0Reference(Location)
nameΣ1..1string
commentΣ0..0markdown
extraDetails0..0markdown
photoΣ C0..0Attachment
contact0..0ExtendedContactDetail
coverageAreaC0..0Reference(Location)
serviceProvisionCode0..0CodeableConcept
program0..0CodeableConcept
characteristic0..0CodeableConcept
communication0..0CodeableConceptBinding
referralMethod0..0CodeableConcept
appointmentRequired0..0boolean
availability0..0Availability
endpointC0..*Reference(Endpoint)
{
"resourceType": "StructureDefinition",
"id": "profile-healthcareservice",
"url": "https://fhir.synapxe.sg/StructureDefinition/profile-healthcareservice",
"version": "1.2.3",
"name": "HealthcareService",
"title": "Healthcare Service Profile",
"status": "active",
"publisher": "Synapxe",
"description": "This resource will be used to store details of a healthcare service available at a location.",
"fhirVersion": "5.0.0",
"kind": "resource",
"abstract": false,
"type": "HealthcareService",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService",
"derivation": "constraint",
"element": [
{
"id": "HealthcareService.identifier",
"path": "HealthcareService.identifier",
"short": "An identifier intended for computation",
"definition": "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
"min": 1,
"type": [
{
"code": "Identifier",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-identifier-hcsa-code"
]
}
]
},
{
"id": "HealthcareService.providedBy",
"path": "HealthcareService.providedBy",
"short": "A reference from one resource to another",
"definition": "A reference from one resource to another.",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min": 1,
"type": [
{
"code": "Reference",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-reference-organization"
],
"https://fhir.synapxe.sg/StructureDefinition/profile-organization"
]
}
]
},
{
"id": "HealthcareService.offeredIn",
"path": "HealthcareService.offeredIn",
"max": "0"
},
{
"id": "HealthcareService.category",
"path": "HealthcareService.category",
"short": "Concept - reference to a terminology or just text",
"definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"type": [
{
"code": "CodeableConcept",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-codeableconcept"
]
}
]
},
{
"id": "HealthcareService.type",
"path": "HealthcareService.type",
"short": "Concept - reference to a terminology or just text",
"definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"type": [
{
"code": "CodeableConcept",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-codeableconcept"
]
}
]
},
{
"id": "HealthcareService.specialty",
"path": "HealthcareService.specialty",
"short": "Concept - reference to a terminology or just text",
"definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"type": [
{
"code": "CodeableConcept",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-codeableconcept"
]
}
]
},
{
"id": "HealthcareService.location",
"path": "HealthcareService.location",
"max": "0"
},
{
"id": "HealthcareService.name",
"path": "HealthcareService.name",
"min": 1
},
{
"id": "HealthcareService.comment",
"path": "HealthcareService.comment",
"max": "0"
},
{
"id": "HealthcareService.extraDetails",
"path": "HealthcareService.extraDetails",
"max": "0"
},
{
"id": "HealthcareService.photo",
"path": "HealthcareService.photo",
"max": "0"
},
{
"id": "HealthcareService.contact",
"path": "HealthcareService.contact",
"max": "0"
},
{
"id": "HealthcareService.coverageArea",
"path": "HealthcareService.coverageArea",
"max": "0"
},
{
"id": "HealthcareService.serviceProvisionCode",
"path": "HealthcareService.serviceProvisionCode",
"max": "0"
},
{
"id": "HealthcareService.eligibility",
"path": "HealthcareService.eligibility",
"max": "0"
},
{
"id": "HealthcareService.program",
"path": "HealthcareService.program",
"max": "0"
},
{
"id": "HealthcareService.characteristic",
"path": "HealthcareService.characteristic",
"max": "0"
},
{
"id": "HealthcareService.communication",
"path": "HealthcareService.communication",
"max": "0"
},
{
"id": "HealthcareService.referralMethod",
"path": "HealthcareService.referralMethod",
"max": "0"
},
{
"id": "HealthcareService.appointmentRequired",
"path": "HealthcareService.appointmentRequired",
"max": "0"
},
{
"id": "HealthcareService.availability",
"path": "HealthcareService.availability",
"max": "0"
}
]
}
}
HealthcareServiceC
ShortThe details of a healthcare service available at a location
Definition

The details of a healthcare service available at a location.

Cardinality0..*
Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: 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-3: 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
  • rim: Entity, Role, or Act
  • w5: administrative.group
  • rim: act[classCode=ACT][moodCode=DEF]
  • interface: Participant
HealthcareService.idΣ
ShortLogical id of this artifact
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality0..1
Typeid
SummaryTrue
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
HealthcareService.metaΣ
ShortMetadata about the resource
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality0..1
TypeMeta
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
HealthcareService.implicitRulesΣ ?!
ShortA set of rules under which this content was created
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
HealthcareService.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

IETF language tag for a human language

AllLanguages (required)

Additional bindings
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
HealthcareService.textC
ShortText summary of the resource, for human interpretation
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

ConditionsThe cardinality or value of this element may be affected by these constraints: dom-6
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
HealthcareService.containedC
ShortContained, inline Resources
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

ConditionsThe cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5
Mappings
  • rim: n/a
  • rim: Entity. Role, or Act
  • rim: N/A
HealthcareService.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
HealthcareService.modifierExtensionΣ ?! C
ShortExtensions that cannot be ignored
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
HealthcareService.identifierΣ C
ShortAn identifier intended for computation
Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Cardinality1..*
TypeIdentifierHCSACode
SummaryTrue
Comments

The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
    value.exists()
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
  • rim: .id
  • interface: Participant.identifier
HealthcareService.activeΣ ?!
ShortWhether this HealthcareService record is in active use
Definition

This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

Cardinality0..1
Typeboolean
ModifierTrue
SummaryTrue
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • rim: .statusCode
  • interface: Participant.active
HealthcareService.providedByΣ C
ShortA reference from one resource to another
Definition

A reference from one resource to another.

Cardinality1..1
TypeReference(Organization)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .scopingRole.Organization
HealthcareService.offeredInC
ShortThe service within which this service is offered
Definition

When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service.

Cardinality0..0
TypeReference(HealthcareService)
Comments

For example, if there is a generic Radiology service that offers CT Scans, MRIs, etc. You could have HealthcareService resources for the CT Scans and MRIs, which have an offeredIn reference to the Radiology HealthcareService.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
HealthcareService.categoryΣ
ShortConcept - reference to a terminology or just text
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Cardinality0..*
TypeCodeableConcept
Binding

A category of the service(s) that could be provided.

ServiceCategory (example)

SummaryTrue
Aliasservice category
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
  • rim: .code
HealthcareService.typeΣ
ShortConcept - reference to a terminology or just text
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Cardinality0..*
TypeCodeableConcept
Binding

Additional details about where the content was created (e.g. clinical specialty).

ServiceType (example)

SummaryTrue
Aliasservice type
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code
HealthcareService.specialtyΣ
ShortConcept - reference to a terminology or just text
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Cardinality0..*
TypeCodeableConcept
Binding

A specialty that a healthcare service may provide.

PracticeSettingCodeValueSet (preferred)

SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code
HealthcareService.locationΣ C
ShortLocation(s) where service may be provided
Definition

The location(s) where this healthcare service may be provided.

Cardinality0..0
TypeReference(Location)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.where[x]
  • rim: .location.role[classCode=SDLOC]
HealthcareService.nameΣ
ShortDescription of service as presented to a consumer while searching
Definition

Further description of the service as it would be presented to a consumer while searching.

Cardinality1..1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .name
  • interface: Participant.name
HealthcareService.commentΣ
ShortAdditional description and/or any specific issues not covered elsewhere
Definition

Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

Cardinality0..0
Typemarkdown
SummaryTrue
Comments

Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .location.role[classCode=SDLOC].desc
HealthcareService.extraDetails
ShortExtra details about the service that can't be placed in the other fields
Definition

Extra details about the service that can't be placed in the other fields.

Cardinality0..0
Typemarkdown
Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text
HealthcareService.photoΣ C
ShortFacilitates quick identification of the service
Definition

If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.

Cardinality0..0
TypeAttachment
SummaryTrue
Comments

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • att-1: If the Attachment has data, it SHALL have a contentType
    data.empty() or contentType.exists()
Mappings
  • rim: n/a
  • v2: ED/RP
  • rim: ED
  • rim: .actrelationship[typeCode=SBJ].observation.value
HealthcareService.contact
ShortOfficial contact details for the HealthcareService
Definition

The contact details of communication devices available relevant to the specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Cardinality0..0
TypeExtendedContactDetail
Requirements

Need to keep track of both simple contact details and also assigned contacts within larger organizations.

Comments

The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the HealthcareService itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.

If this is empty (or the type of interest is empty), refer to the location's contacts.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
HealthcareService.coverageAreaC
ShortLocation(s) service is intended for/available to
Definition

The location(s) that this service is available to (not where the service is provided).

Cardinality0..0
TypeReference(Location)
Comments

The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate
HealthcareService.serviceProvisionCode
ShortConditions under which service is available/offered
Definition

The code(s) that detail the conditions under which the healthcare service is available/offered.

Cardinality0..0
TypeCodeableConcept
Binding

The code(s) that detail the conditions under which the healthcare service is available/offered.

ServiceProvisionConditions (example)

Comments

The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]
HealthcareService.eligibility
ShortSpecific eligibility requirements required to use the service
Definition

Does this service have specific eligibility requirements that need to be met in order to use the service?

Cardinality0..0
TypeBackboneElement
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
HealthcareService.eligibility.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Mappings
  • rim: n/a
HealthcareService.eligibility.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
HealthcareService.eligibility.modifierExtensionΣ ?! C
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
HealthcareService.eligibility.code
ShortCoded value for the eligibility
Definition

Coded value for the eligibility.

Cardinality0..1
TypeCodeableConcept
Binding

Coded values underwhich a specific service is made available.

(unbound) (example)

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]
HealthcareService.eligibility.comment
ShortDescribes the eligibility conditions for the service
Definition

Describes the eligibility conditions for the service.

Cardinality0..1
Typemarkdown
Comments

The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text
HealthcareService.program
ShortPrograms that this service is applicable to
Definition

Programs that this service is applicable to.

Cardinality0..0
TypeCodeableConcept
Binding

Government or local programs that this service applies to.

Program (example)

Comments

Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .actrelationship[typeCode=PERT].observation
HealthcareService.characteristic
ShortCollection of characteristics (attributes)
Definition

Collection of characteristics (attributes).

Cardinality0..0
TypeCodeableConcept
Binding

A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).

ServiceMode (example)

Comments

These could be such things as is wheelchair accessible.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .actrelationship[typeCode=PERT].observation
HealthcareService.communication
ShortThe language that this service is offered in
Definition

Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

Cardinality0..0
TypeCodeableConcept
Binding

IETF language tag for a human language

AllLanguages (required)

Additional bindings
Comments

When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
HealthcareService.referralMethod
ShortWays that the service accepts referrals
Definition

Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

Cardinality0..0
TypeCodeableConcept
Binding

The methods of referral can be used when referring to a specific HealthcareService resource.

ReferralMethod (example)

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .actrelationship[typeCode=PERT].observation
HealthcareService.appointmentRequired
ShortIf an appointment is required for access to this service
Definition

Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

Cardinality0..0
Typeboolean
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .actrelationship[typeCode=PERT].observation
HealthcareService.availability
ShortTimes the healthcare service is available (including exceptions)
Definition

A collection of times that the healthcare service is available.

Cardinality0..0
TypeAvailability
Comments

More detailed availability information may be provided in associated Schedule/Slot resources.

Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm".

The NotAvailableTime(s) included indicate the general days/periods where the service is not available (for things such as public holidays).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .effectiveTime
HealthcareService.endpointC
ShortTechnical endpoints providing access to electronic services operated for the healthcare service
Definition

Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Cardinality0..*
TypeReference(Endpoint)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
  • ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided).
    reference.exists() or identifier.exists() or display.exists() or extension.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

Terminology Bindings

titlePathBinding StrengthValue Set (Code System)Description
Healthcare Service ProfileHealthcareService.languagerequiredhttp://hl7.org/fhir/ValueSet/all-languages|5.0.0

IETF language tag for a human language

Healthcare Service ProfileHealthcareService.categoryexamplehttp://hl7.org/fhir/ValueSet/service-category

A category of the service(s) that could be provided.

Healthcare Service ProfileHealthcareService.typeexamplehttp://hl7.org/fhir/ValueSet/service-type

Additional details about where the content was created (e.g. clinical specialty).

Healthcare Service ProfileHealthcareService.specialtypreferredhttp://hl7.org/fhir/ValueSet/c80-practice-codes

A specialty that a healthcare service may provide.

Healthcare Service ProfileHealthcareService.eligibility.codeexample

Coded values underwhich a specific service is made available.

Constraints