Page Status: draft updated 2025-08-08
HealthcareService - HVOService
Information domain hvo-offerings, where this resource is represented as Tjänst
Page index
General information
See HL7 HealthcareService for general information about the resource.
Scope and Usage
The HealthcareService resource as it is profiled in HVOService contains information about activities that are offered by organizational units in order to accomodate a requisite. This can be because of a legal requirement.
A HVOService is can only be created and updated together with a HVOOrganizationalUnit and a HVOContract. This is done using a Bundle - HVOContractTransactionBundle.
Profile
HVOService (HealthcareService) | C | HealthcareService | |
id | S Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | C | 1..* | Extension |
period | S C | 1..1 | Extension(Period) |
id | 0..1 | string | |
extension | C | 0..0 | Extension |
url | S | 1..1 | uriFixed Value |
value[x] | S | 1..1 | |
valuePeriod | Period | ||
id | 0..1 | string | |
extension | C | 0..* | Extension |
start | S Σ C | 1..1 | dateTime |
end | Σ C | 0..1 | dateTime |
contact | S C | 0..* | Extension(Complex) |
modifierExtension | ?! C | 0..* | Extension |
identifier | S Σ | 1..1 | Identifier |
active | Σ ?! | 0..1 | boolean |
providedBy | S Σ | 1..1 | Reference(HVOOrganizationalUnit) |
category | Σ | 0..* | CodeableConcept |
type | Σ | 0..* | CodeableConcept |
specialty | S Σ | 1..1 | CodeableConceptBinding |
location | S Σ | 0..* | Reference(HVOLocation) |
name | Σ | 0..1 | string |
comment | S Σ | 0..1 | string |
extraDetails | 0..1 | markdown | |
photo | Σ | 0..1 | Attachment |
telecom | 0..* | ContactPoint | |
coverageArea | 0..* | Reference(Location) | |
serviceProvisionCode | 0..* | CodeableConcept | |
eligibility | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
eligbilityValue | S C | 0..1 | Extension(Reference(HVOEligibilityGroup)) |
modifierExtension | Σ ?! C | 0..* | Extension |
code | 0..1 | CodeableConcept | |
comment | S | 1..1 | markdown |
program | 0..* | CodeableConcept | |
characteristic | S | 1..* | CodeableConceptBinding |
id | 0..1 | string | |
extension | C | 0..* | Extension |
coding | S Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | C | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
communication | 0..* | CodeableConceptBinding | |
referralMethod | 0..* | CodeableConcept | |
appointmentRequired | 0..1 | boolean | |
availableTime | S | 1..* | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
daysOfWeek | S | 1..* | codeBinding |
allDay | S | 0..1 | boolean |
availableStartTime | S | 0..1 | time |
availableEndTime | S | 0..1 | time |
notAvailable | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
description | S | 1..1 | string |
during | S | 0..1 | Period |
id | 0..1 | string | |
extension | C | 0..* | Extension |
start | S Σ C | 1..1 | dateTime |
end | S Σ C | 0..1 | dateTime |
availabilityExceptions | 0..1 | string | |
endpoint | 0..* | Reference(Endpoint) |
HealthcareService | |||
Short | The details of a healthcare service available at a location | ||
Definition | The details of a healthcare service available at a location. | ||
Cardinality | 0..* | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.id | |||
Short | Logical 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Must Support | True | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
HealthcareService.meta | |||
Short | Metadata 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. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
Constraints |
| ||
HealthcareService.implicitRules | |||
Short | A 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. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
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 it's narrative along with other profiles, value sets, etc. | ||
Constraints |
| ||
HealthcareService.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language.
| ||
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 |
| ||
HealthcareService.text | |||
Short | Text 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. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | Contained resources do not have 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. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.contained | |||
Short | Contained, inline Resources | ||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline 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. | ||
Mappings |
| ||
HealthcareService.extension | |||
Short | Additional 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 manageable, 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. | ||
Cardinality | 1..* | ||
Type | Extension | ||
Alias | extensions, 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) | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.extension:period | |||
Short | Optional Extensions Element | ||
Definition | Extension for the period during which a service is available and offered | ||
Cardinality | 1..1 | ||
Type | Extension(Period) | ||
Must Support | True | ||
Alias | extensions, 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.extension:period.id | |||
Short | Unique 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
HealthcareService.extension:period.extension | |||
Short | Additional 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 manageable, 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. | ||
Cardinality | 0..0 | ||
Type | Extension | ||
Alias | extensions, 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 |
| ||
Mappings |
| ||
HealthcareService.extension:period.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
Fixed Value | http://electronichealth.se/fhir/hvo/StructureDefinition/HVOHealthcareServicePeriodExtension | ||
Mappings |
| ||
HealthcareService.extension:period.value[x] | |||
Short | Value of extension | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Cardinality | 1..1 | ||
Type | Period | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.extension:period.value[x].id | |||
Short | Unique 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
HealthcareService.extension:period.value[x].extension | |||
Short | Additional 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 manageable, 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, 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 |
| ||
Mappings |
| ||
HealthcareService.extension:period.value[x].start | |||
Short | Extension for the period during which a service is available and offered | ||
Definition | The start of the period. The boundary is inclusive. | ||
Cardinality | 1..1 | ||
Type | dateTime | ||
Must Support | True | ||
Summary | True | ||
Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.extension:period.value[x].end | |||
Short | End time with inclusive boundary, if not ongoing | ||
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||
Meaning when missing | If the end of the period is missing, it means that the period is ongoing | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.extension:contact | |||
Short | Optional Extensions Element | ||
Definition | Extensions to add R5 ExtendedContactDetail data type to R4. HVOContactExtension contains information about where and how a person or an organization can be reached. | ||
Cardinality | 0..* | ||
Type | Extension(Complex) | ||
Must Support | True | ||
Alias | extensions, 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.modifierExtension | |||
Short | Extensions 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 manageable, 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). | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, 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. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.identifier | |||
Short | External identifiers for this item | ||
Definition | External identifiers for this item. | ||
Cardinality | 1..1 | ||
Type | Identifier | ||
Must Support | True | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.active | |||
Short | Whether 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. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Modifier | True | ||
Summary | True | ||
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 |
| ||
Mappings |
| ||
HealthcareService.providedBy | |||
Short | Organization that provides this service | ||
Definition | The organization that provides this healthcare service. | ||
Cardinality | 1..1 | ||
Type | Reference(HVOOrganizationalUnit) | ||
Must Support | True | ||
Summary | True | ||
Comments | This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.category | |||
Short | Broad category of service being performed or delivered | ||
Definition | Identifies the broad category of service being performed or delivered. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | A category of the service(s) that could be provided. | ||
Summary | True | ||
Alias | service category | ||
Comments | Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.type | |||
Short | Type of service that may be delivered or performed | ||
Definition | The specific type of service that may be delivered or performed. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | Additional details about where the content was created (e.g. clinical specialty). | ||
Summary | True | ||
Alias | service type | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.specialty | |||
Short | Specialties handled by the HealthcareService | ||
Definition | Collection of specialties handled by the service site. This is more of a medical term. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | A specialty that a healthcare service may provide. | ||
Must Support | True | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.location | |||
Short | Location(s) where service may be provided | ||
Definition | The location(s) where this healthcare service may be provided. | ||
Cardinality | 0..* | ||
Type | Reference(HVOLocation) | ||
Must Support | True | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.name | |||
Short | Description 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.comment | |||
Short | Textual description of service. It is used to complement the type element incase a textual description is necessary | ||
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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Must Support | True | ||
Summary | True | ||
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 |
| ||
Mappings |
| ||
HealthcareService.extraDetails | |||
Short | Extra 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. | ||
Cardinality | 0..1 | ||
Type | markdown | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.photo | |||
Short | Facilitates 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. | ||
Cardinality | 0..1 | ||
Type | Attachment | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.telecom | |||
Short | Contacts related to the healthcare service | ||
Definition | List of contacts related to this specific healthcare service. | ||
Cardinality | 0..* | ||
Type | ContactPoint | ||
Comments | If this is empty, then refer to the location's contacts. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.coverageArea | |||
Short | Location(s) service is intended for/available to | ||
Definition | The location(s) that this service is available to (not where the service is provided). | ||
Cardinality | 0..* | ||
Type | Reference(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 |
| ||
Mappings |
| ||
HealthcareService.serviceProvisionCode | |||
Short | Conditions under which service is available/offered | ||
Definition | The code(s) that detail the conditions under which the healthcare service is available/offered. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | The code(s) that detail the conditions under which the healthcare service is available/offered. | ||
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 |
| ||
Mappings |
| ||
HealthcareService.eligibility | |||
Short | Specific 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? | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.eligibility.id | |||
Short | Unique 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
HealthcareService.eligibility.extension | |||
Short | Additional 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 manageable, 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, 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) | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.eligibility.extension:eligbilityValue | |||
Short | Optional Extensions Element | ||
Definition | Extension for HealthcareService.eligibility to reference a Group | ||
Cardinality | 0..1 | ||
Type | Extension(Reference(HVOEligibilityGroup)) | ||
Must Support | True | ||
Alias | extensions, 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.eligibility.modifierExtension | |||
Short | Extensions 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 manageable, 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). | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | extensions, 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 |
| ||
Mappings |
| ||
HealthcareService.eligibility.code | |||
Short | Coded value for the eligibility | ||
Definition | Coded value for the eligibility. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | Coded values underwhich a specific service is made available. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.eligibility.comment | |||
Short | Describes the eligibility conditions for the service | ||
Definition | Describes the eligibility conditions for the service. | ||
Cardinality | 1..1 | ||
Type | markdown | ||
Must Support | True | ||
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 |
| ||
Mappings |
| ||
HealthcareService.program | |||
Short | Programs that this service is applicable to | ||
Definition | Programs that this service is applicable to. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | Government or local programs that this service applies to. | ||
Comments | Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.characteristic | |||
Short | What form(s) of encounter the service offers, e.g. chat, phone call, physical meetup | ||
Definition | Collection of characteristics (attributes). | ||
Cardinality | 1..* | ||
Type | CodeableConcept | ||
Binding | A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||
Must Support | True | ||
Comments | These could be such things as is wheelchair accessible. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.characteristic.id | |||
Short | Unique 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
HealthcareService.characteristic.extension | |||
Short | Additional 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 manageable, 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, 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 |
| ||
Mappings |
| ||
HealthcareService.characteristic.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 1..1 | ||
Type | Coding | ||
Must Support | True | ||
Summary | True | ||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.characteristic.coding.id | |||
Short | Unique 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
HealthcareService.characteristic.coding.extension | |||
Short | Additional 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 manageable, 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, 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 |
| ||
Mappings |
| ||
HealthcareService.characteristic.coding.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.characteristic.coding.version | |||
Short | Version of the system - if relevant | ||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.characteristic.coding.code | |||
Short | Symbol in syntax defined by the system | ||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
Cardinality | 1..1 | ||
Type | code | ||
Must Support | True | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.characteristic.coding.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.characteristic.coding.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Summary | True | ||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.characteristic.text | |||
Short | Plain text representation of the concept | ||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.communication | |||
Short | The 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. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | A human language.
| ||
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 |
| ||
HealthcareService.referralMethod | |||
Short | Ways 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. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | The methods of referral can be used when referring to a specific HealthCareService resource. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.appointmentRequired | |||
Short | If 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. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.availableTime | |||
Short | Times the Service Site is available | ||
Definition | A collection of times that the Service Site is available. | ||
Cardinality | 1..* | ||
Type | BackboneElement | ||
Must Support | True | ||
Comments | More detailed availability information may be provided in associated Schedule/Slot resources. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.availableTime.id | |||
Short | Unique 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
HealthcareService.availableTime.extension | |||
Short | Additional 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 manageable, 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, 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. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.availableTime.modifierExtension | |||
Short | Extensions 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 manageable, 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). | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | extensions, 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 |
| ||
Mappings |
| ||
HealthcareService.availableTime.daysOfWeek | |||
Short | mon | tue | wed | thu | fri | sat | sun | ||
Definition | Indicates which days of the week are available between the start and end Times. | ||
Cardinality | 1..* | ||
Type | code | ||
Binding | The days of the week. | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.availableTime.allDay | |||
Short | Always available? e.g. 24 hour service | ||
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.availableTime.availableStartTime | |||
Short | Opening time of day (ignored if allDay = true) | ||
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored. | ||
Cardinality | 0..1 | ||
Type | time | ||
Must Support | True | ||
Comments | The time zone is expected to be for where this HealthcareService is provided at. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.availableTime.availableEndTime | |||
Short | Closing time of day (ignored if allDay = true) | ||
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored. | ||
Cardinality | 0..1 | ||
Type | time | ||
Must Support | True | ||
Comments | The time zone is expected to be for where this HealthcareService is provided at. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.notAvailable | |||
Short | Not available during this time due to provided reason | ||
Definition | The HealthcareService is not available during this period of time due to the provided reason. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.notAvailable.id | |||
Short | Unique 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
HealthcareService.notAvailable.extension | |||
Short | Additional 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 manageable, 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, 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. | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.notAvailable.modifierExtension | |||
Short | Extensions 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 manageable, 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). | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | extensions, 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 |
| ||
Mappings |
| ||
HealthcareService.notAvailable.description | |||
Short | Reason presented to the user explaining why time not available | ||
Definition | The reason that can be presented to the user as to why this time is not available. | ||
Cardinality | 1..1 | ||
Type | string | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.notAvailable.during | |||
Short | Service not available from this date | ||
Definition | Service is not available (seasonally or for a public holiday) from this date. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.notAvailable.during.id | |||
Short | Unique 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
HealthcareService.notAvailable.during.extension | |||
Short | Additional 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 manageable, 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, 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 |
| ||
Mappings |
| ||
HealthcareService.notAvailable.during.start | |||
Short | Starting time with inclusive boundary | ||
Definition | The start of the period. The boundary is inclusive. | ||
Cardinality | 1..1 | ||
Type | dateTime | ||
Must Support | True | ||
Summary | True | ||
Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.notAvailable.during.end | |||
Short | End time with inclusive boundary, if not ongoing | ||
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Must Support | True | ||
Summary | True | ||
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||
Meaning when missing | If the end of the period is missing, it means that the period is ongoing | ||
Conditions | The cardinality or value of this element may be affected by these constraints: per-1 | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.availabilityExceptions | |||
Short | Description of availability exceptions | ||
Definition | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. | ||
Cardinality | 0..1 | ||
Type | string | ||
Constraints |
| ||
Mappings |
| ||
HealthcareService.endpoint | |||
Short | Technical 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. | ||
Cardinality | 0..* | ||
Type | Reference(Endpoint) | ||
Constraints |
| ||
Mappings |
|
Details
The must-support flag indicates that the element is expected in some use cases, and a missing flag that the element is never used.
Supported operations
HTTP methods
Operation | Supported | Comment |
---|---|---|
Search (GET, POST) | no | |
Insert (POST) | no | See Bundle - HVOContractTransactionBundle for creating HVOServices |
Update (PUT) | no | See Bundle - HVOContractTransactionBundle for updating HVOServices |
Delete (DEL) | no | |
Operation (GET, POST) | no |