Imaging Study
Defines the ID Core constraints and extensions on the HealthcareService resource for the minimal set of data to query and retrieve healthcare services.
Usage
The HealthcareService resource is used to describe a single healthcare service or category of services that are provided by an organization at a location.
The location of the services could be virtual, as with telemedicine services.
URL
Type | URL |
---|---|
Canonical | https://fhir.kemkes.go.id/r4/StructureDefinition/HealthcareService |
Structure
Snapshot
HealthcareService | I | DomainResource | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
identifier | Σ | 0..* | Identifier |
active | Σ ?! | 0..1 | boolean |
providedBy | Σ I | 0..1 | Reference(Organization) |
category | Σ | 0..* | CodeableConcept |
type | Σ | 0..* | CodeableConcept |
specialty | Σ | 0..* | CodeableConceptBinding |
location | Σ I | 0..* | Reference(Location) |
name | Σ | 0..1 | string |
comment | Σ | 0..1 | string |
extraDetails | 0..1 | markdown | |
photo | Σ I | 0..1 | Attachment |
telecom | I | 0..* | ContactPoint |
coverageArea | I | 0..* | Reference(Location) |
serviceProvisionCode | 0..* | CodeableConcept | |
eligibility | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | 0..1 | CodeableConcept | |
comment | 0..1 | markdown | |
program | 0..* | CodeableConcept | |
characteristic | 0..* | CodeableConcept | |
communication | 0..* | CodeableConceptBinding | |
referralMethod | 0..* | CodeableConcept | |
appointmentRequired | 0..1 | boolean | |
availableTime | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
daysOfWeek | 0..* | codeBinding | |
allDay | 0..1 | boolean | |
availableStartTime | 0..1 | time | |
availableEndTime | 0..1 | time | |
notAvailable | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
description | 1..1 | string | |
during | I | 0..1 | Period |
availabilityExceptions | 0..1 | string | |
endpoint | I | 0..* | Reference(https://fhir.kemkes.go.id/r4/StructureDefinition/Endpoint) |
Examples
Dictionary
HealthcareService | |
Definition | The details of a healthcare service available at a location. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
HealthcareService.id | |
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 |
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 | |
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 |
Invariants |
|
Mappings |
|
HealthcareService.implicitRules | |
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. |
Invariants |
|
Mappings |
|
HealthcareService.language | |
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). |
Invariants |
|
Mappings |
|
HealthcareService.text | |
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. |
Invariants |
|
Mappings |
|
HealthcareService.contained | |
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.identifier | |
Definition | External identifiers for this item. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Invariants |
|
Mappings |
|
HealthcareService.active | |
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. |
Invariants |
|
Mappings |
|
HealthcareService.providedBy | |
Definition | The organization that provides this healthcare service. |
Cardinality | 0...1 |
Type | Reference(Organization) |
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. |
Invariants |
|
Mappings |
|
HealthcareService.category | |
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. |
Invariants |
|
Mappings |
|
HealthcareService.type | |
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 |
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. |
Invariants |
|
Mappings |
|
HealthcareService.specialty | |
Definition | Collection of specialties handled by the service site. This is more of a medical term. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A specialty that a healthcare service may provide. |
Summary | True |
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. |
Invariants |
|
Mappings |
|
HealthcareService.location | |
Definition | The location(s) where this healthcare service may be provided. |
Cardinality | 0...* |
Type | Reference(Location) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. |
Invariants |
|
Mappings |
|
HealthcareService.name | |
Definition | Further description of the service as it would be presented to a consumer while searching. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
HealthcareService.comment | |
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 |
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. |
Invariants |
|
Mappings |
|
HealthcareService.extraDetails | |
Definition | Extra details about the service that can't be placed in the other fields. |
Cardinality | 0...1 |
Type | markdown |
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/ |
Invariants |
|
Mappings |
|
HealthcareService.photo | |
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 |
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". |
Invariants |
|
Mappings |
|
HealthcareService.telecom | |
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. |
Invariants |
|
Mappings |
|
HealthcareService.coverageArea | |
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". |
Invariants |
|
Mappings |
|
HealthcareService.serviceProvisionCode | |
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. |
Invariants |
|
Mappings |
|
HealthcareService.eligibility | |
Definition | Does this service have specific eligibility requirements that need to be met in order to use the service? |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
HealthcareService.eligibility.id | |
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 | |
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) |
Invariants |
|
Mappings |
|
HealthcareService.eligibility.modifierExtension | |
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. |
Invariants |
|
Mappings |
|
HealthcareService.eligibility.code | |
Definition | Coded value for the eligibility. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Coded values underwhich a specific service is made available. |
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. |
Invariants |
|
Mappings |
|
HealthcareService.eligibility.comment | |
Definition | Describes the eligibility conditions for the service. |
Cardinality | 0...1 |
Type | markdown |
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. |
Invariants |
|
Mappings |
|
HealthcareService.program | |
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, …. |
Invariants |
|
Mappings |
|
HealthcareService.characteristic | |
Definition | Collection of characteristics (attributes). |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). |
Comments | These could be such things as is wheelchair accessible. |
Invariants |
|
Mappings |
|
HealthcareService.communication | |
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. |
Invariants |
|
Mappings |
|
HealthcareService.referralMethod | |
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. |
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. |
Invariants |
|
Mappings |
|
HealthcareService.appointmentRequired | |
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 |
Invariants |
|
Mappings |
|
HealthcareService.availableTime | |
Definition | A collection of times that the Service Site is available. |
Cardinality | 0...* |
Type | BackboneElement |
Comments | More detailed availability information may be provided in associated Schedule/Slot resources. |
Invariants |
|
Mappings |
|
HealthcareService.availableTime.id | |
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 | |
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) |
Invariants |
|
Mappings |
|
HealthcareService.availableTime.modifierExtension | |
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. |
Invariants |
|
Mappings |
|
HealthcareService.availableTime.daysOfWeek | |
Definition | Indicates which days of the week are available between the start and end Times. |
Cardinality | 0...* |
Type | code |
Binding | The days of the week. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
HealthcareService.availableTime.allDay | |
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. |
Cardinality | 0...1 |
Type | boolean |
Invariants |
|
Mappings |
|
HealthcareService.availableTime.availableStartTime | |
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored. |
Cardinality | 0...1 |
Type | time |
Comments | The time zone is expected to be for where this HealthcareService is provided at. |
Invariants |
|
Mappings |
|
HealthcareService.availableTime.availableEndTime | |
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored. |
Cardinality | 0...1 |
Type | time |
Comments | The time zone is expected to be for where this HealthcareService is provided at. |
Invariants |
|
Mappings |
|
HealthcareService.notAvailable | |
Definition | The HealthcareService is not available during this period of time due to the provided reason. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
HealthcareService.notAvailable.id | |
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 | |
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) |
Invariants |
|
Mappings |
|
HealthcareService.notAvailable.modifierExtension | |
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. |
Invariants |
|
Mappings |
|
HealthcareService.notAvailable.description | |
Definition | The reason that can be presented to the user as to why this time is not available. |
Cardinality | 1...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
HealthcareService.notAvailable.during | |
Definition | Service is not available (seasonally or for a public holiday) from this date. |
Cardinality | 0...1 |
Type | Period |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
HealthcareService.availabilityExceptions | |
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 |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
HealthcareService.endpoint | |
Definition | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. |
Cardinality | 0...* |
Type | Reference(https://fhir.kemkes.go.id/r4/StructureDefinition/Endpoint) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. |
Invariants |
|
Mappings |
|