HealthcareService
This resource will be used to store details of a healthcare service available at a location.
| HealthcareService | C | HealthcareService | There are no (further) constraints on this element Element idHealthcareServiceShort description The details of a healthcare service available at a location DefinitionThe details of a healthcare service available at a location.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idHealthcareService.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. 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. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idHealthcareService.metaShort description Metadata about the resource DefinitionThe 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.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idHealthcareService.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idHealthcareService.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). IETF language tag for a human language
| |
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idHealthcareService.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: dom-6 Constraints
|
| contained | C | 0..* | Resource | There are no (further) constraints on this element Element idHealthcareService.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 Mappings
|
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idHealthcareService.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idHealthcareService.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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.
|
| identifier | Σ | 1..* | Identifier | There are no (further) constraints on this element Element idHealthcareService.identifierShort description External identifiers for this item DefinitionExternal identifiers for this item.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idHealthcareService.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idHealthcareService.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idHealthcareService.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idHealthcareService.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeCodes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idHealthcareService.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.synapxe.sg/NamingSystem/hcsa-codeExamples General http://www.acme.com/identifiers/patientMappings
|
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idHealthcareService.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. The cardinality or value of this element may be affected by these constraints: ident-1 Constraints
General 123456Mappings
|
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idHealthcareService.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idHealthcareService.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idHealthcareService.activeShort description Whether this HealthcareService record is in active use DefinitionThis 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. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
|
| providedBy | Σ | 1..1 | Reference(Organization) | There are no (further) constraints on this element Element idHealthcareService.providedByShort description Organization that provides this service DefinitionThe organization that provides this healthcare service. 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.
|
| offeredIn | 0..0 | Reference(HealthcareService) | There are no (further) constraints on this element Element idHealthcareService.offeredInShort description The service within which this service is offered DefinitionWhen the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service. 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.
| |
| category | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.categoryShort description Broad category of service being performed or delivered Alternate namesservice category DefinitionIdentifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type. A category of the service(s) that could be provided.
|
| type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.typeShort description Type of service that may be delivered or performed Alternate namesservice type DefinitionThe specific type of service that may be delivered or performed. Additional details about where the content was created (e.g. clinical specialty).
|
| specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idHealthcareService.specialtyShort description Specialties handled by the HealthcareService DefinitionCollection of specialties handled by the Healthcare service. This is more of a medical term. A specialty that a healthcare service may provide. PracticeSettingCodeValueSet (preferred) Constraints
|
| location | Σ | 0..0 | Reference(Location) | There are no (further) constraints on this element Element idHealthcareService.locationShort description Location(s) where service may be provided DefinitionThe location(s) where this healthcare service may be provided.
|
| name | Σ | 1..1 | string | There are no (further) constraints on this element Element idHealthcareService.nameShort description Description of service as presented to a consumer while searching DefinitionFurther description of the service as it would be presented to a consumer while searching.
|
| comment | Σ | 0..0 | markdown | There are no (further) constraints on this element Element idHealthcareService.commentShort description Additional description and/or any specific issues not covered elsewhere DefinitionAny 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. 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.
|
| extraDetails | 0..0 | markdown | There are no (further) constraints on this element Element idHealthcareService.extraDetailsShort description Extra details about the service that can't be placed in the other fields DefinitionExtra details about the service that can't be placed in the other fields.
| |
| photo | Σ | 0..0 | Attachment | There are no (further) constraints on this element Element idHealthcareService.photoShort description Facilitates quick identification of the service DefinitionIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
|
| contact | 0..0 | ExtendedContactDetail | There are no (further) constraints on this element Element idHealthcareService.contactShort description Official contact details for the HealthcareService DefinitionThe 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. Need to keep track of both simple contact details and also assigned contacts within larger organizations. 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.
| |
| coverageArea | 0..0 | Reference(Location) | There are no (further) constraints on this element Element idHealthcareService.coverageAreaShort description Location(s) service is intended for/available to DefinitionThe location(s) that this service is available to (not where the service is provided). 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".
| |
| serviceProvisionCode | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.serviceProvisionCodeShort description Conditions under which service is available/offered DefinitionThe code(s) that detail the conditions under which the healthcare service is available/offered. 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. The code(s) that detail the conditions under which the healthcare service is available/offered. ServiceProvisionConditions (example) Constraints
| |
| eligibility | 0..0 | BackboneElement | There are no (further) constraints on this element Element idHealthcareService.eligibilityShort description Specific eligibility requirements required to use the service DefinitionDoes this service have specific eligibility requirements that need to be met in order to use the service?
| |
| program | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.programShort description Programs that this service is applicable to DefinitionPrograms that this service is applicable to. Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. Government or local programs that this service applies to.
| |
| characteristic | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.characteristicShort description Collection of characteristics (attributes) DefinitionCollection of characteristics (attributes). These could be such things as is wheelchair accessible. A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).
| |
| communication | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idHealthcareService.communicationShort description The language that this service is offered in DefinitionSome 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. 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. IETF language tag for a human language
| |
| referralMethod | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idHealthcareService.referralMethodShort description Ways that the service accepts referrals DefinitionWays that the service accepts referrals, if this is not provided then it is implied that no referral is required. The methods of referral can be used when referring to a specific HealthcareService resource.
| |
| appointmentRequired | 0..0 | boolean | There are no (further) constraints on this element Element idHealthcareService.appointmentRequiredShort description If an appointment is required for access to this service DefinitionIndicates 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.
| |
| availability | 0..0 | Availability | There are no (further) constraints on this element Element idHealthcareService.availabilityShort description Times the healthcare service is available (including exceptions) DefinitionA collection of times that the healthcare service is available. 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).
| |
| endpoint | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idHealthcareService.endpointShort description Technical endpoints providing access to electronic services operated for the healthcare service DefinitionTechnical endpoints providing access to services operated for the specific healthcare services defined at this resource.
|
Terminologies
| Path | Binding Strength | Value Set (Code System) | Description |
|---|---|---|---|
| HealthcareService.language | required | http://hl7.org/fhir/ValueSet/all-languages|5.0.0 | IETF language tag for a human language |
| HealthcareService.category | example | http://hl7.org/fhir/ValueSet/service-category | A category of the service(s) that could be provided. |
| HealthcareService.type | example | http://hl7.org/fhir/ValueSet/service-type | Additional details about where the content was created (e.g. clinical specialty). |
| HealthcareService.specialty | preferred | http://hl7.org/fhir/ValueSet/c80-practice-codes | A specialty that a healthcare service may provide. |
| HealthcareService.eligibility.code | example | Coded values underwhich a specific service is made available. |