{
"description": "The details of a healthcare service available at a location.",
"_filename": "HealthcareService.json",
"package_name": "hl7.fhir.r4.id.core",
"date": "2019-11-01T09:29:23+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2021-12-31T10:56:46.064+00:00"
},
"publisher": "Health Level Seven International (Patient Administration)",
"fhirVersion": "4.0.1",
"name": "HealthcareService",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": "HealthcareService",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Base.Entities"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "business"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pa"
} ],
"status": "draft",
"id": "fe18006d-4e35-4f08-a091-076693bae626",
"kind": "resource",
"url": "https://fhir.kemkes.go.id/r4/StructureDefinition/HealthcareService",
"version": "4.0.1",
"differential": {
"element": [ {
"id": "HealthcareService",
"path": "HealthcareService",
"short": "The details of a healthcare service available at a location",
"mapping": [ {
"map": "act[classCode=ACT][moodCode=DEF]",
"identity": "rim"
} ],
"definition": "The details of a healthcare service available at a location."
}, {
"id": "HealthcareService.identifier",
"path": "HealthcareService.identifier",
"type": [ {
"code": "Identifier"
} ],
"short": "External identifiers for this item",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": ".id",
"identity": "rim"
} ],
"isSummary": true,
"definition": "External identifiers for this item."
}, {
"path": "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.",
"isModifier": true,
"short": "Whether this HealthcareService record is in active use",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": ".statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element",
"max": "1",
"id": "HealthcareService.active",
"comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary": true
}, {
"path": "HealthcareService.providedBy",
"definition": "The organization that provides this healthcare service.",
"short": "Organization that provides this service",
"mapping": [ {
"map": ".scopingRole.Organization",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "HealthcareService.providedBy",
"comment": "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.",
"isSummary": true
}, {
"path": "HealthcareService.category",
"definition": "Identifies the broad category of service being performed or delivered.",
"short": "Broad category of service being performed or delivered",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": ".code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/service-category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-category"
} ],
"description": "A category of the service(s) that could be provided."
},
"alias": [ "service category" ],
"id": "HealthcareService.category",
"comment": "Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.",
"isSummary": true
}, {
"path": "HealthcareService.type",
"definition": "The specific type of service that may be delivered or performed.",
"short": "Type of service that may be delivered or performed",
"mapping": [ {
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/service-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-type"
} ],
"description": "Additional details about where the content was created (e.g. clinical specialty)."
},
"alias": [ "service type" ],
"id": "HealthcareService.type",
"isSummary": true
}, {
"id": "HealthcareService.specialty",
"path": "HealthcareService.specialty",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Specialties handled by the HealthcareService",
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-specialty"
} ],
"description": "A specialty that a healthcare service may provide."
},
"mapping": [ {
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code",
"identity": "rim"
} ],
"isSummary": true,
"definition": "Collection of specialties handled by the service site. This is more of a medical term."
}, {
"id": "HealthcareService.location",
"path": "HealthcareService.location",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"short": "Location(s) where service may be provided",
"mapping": [ {
"map": "FiveWs.where[x]",
"identity": "w5"
}, {
"map": ".location.role[classCode=SDLOC]",
"identity": "rim"
} ],
"isSummary": true,
"definition": "The location(s) where this healthcare service may be provided."
}, {
"id": "HealthcareService.name",
"max": "1",
"path": "HealthcareService.name",
"type": [ {
"code": "string"
} ],
"short": "Description of service as presented to a consumer while searching",
"mapping": [ {
"map": ".name",
"identity": "rim"
} ],
"isSummary": true,
"definition": "Further description of the service as it would be presented to a consumer while searching."
}, {
"path": "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.",
"short": "Additional description and/or any specific issues not covered elsewhere",
"mapping": [ {
"map": ".location.role[classCode=SDLOC].desc",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.comment",
"comment": "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.",
"isSummary": true
}, {
"id": "HealthcareService.extraDetails",
"max": "1",
"path": "HealthcareService.extraDetails",
"type": [ {
"code": "markdown"
} ],
"short": "Extra details about the service that can't be placed in the other fields",
"mapping": [ {
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text",
"identity": "rim"
} ],
"definition": "Extra details about the service that can't be placed in the other fields."
}, {
"id": "HealthcareService.photo",
"max": "1",
"path": "HealthcareService.photo",
"type": [ {
"code": "Attachment"
} ],
"short": "Facilitates quick identification of the service",
"mapping": [ {
"map": ".actrelationship[typeCode=SBJ].observation.value",
"identity": "rim"
} ],
"isSummary": true,
"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."
}, {
"id": "HealthcareService.telecom",
"path": "HealthcareService.telecom",
"type": [ {
"code": "ContactPoint"
} ],
"short": "Contacts related to the healthcare service",
"comment": "If this is empty, then refer to the location's contacts.",
"mapping": [ {
"map": ".telecom",
"identity": "rim"
} ],
"definition": "List of contacts related to this specific healthcare service."
}, {
"id": "HealthcareService.coverageArea",
"path": "HealthcareService.coverageArea",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"short": "Location(s) service is intended for/available to",
"comment": "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\".",
"mapping": [ {
"map": ".location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate",
"identity": "rim"
} ],
"definition": "The location(s) that this service is available to (not where the service is provided)."
}, {
"id": "HealthcareService.serviceProvisionCode",
"path": "HealthcareService.serviceProvisionCode",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Conditions under which service is available/offered",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/service-provision-conditions",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProvisionConditions"
} ],
"description": "The code(s) that detail the conditions under which the healthcare service is available/offered."
},
"comment": "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.",
"mapping": [ {
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]",
"identity": "rim"
} ],
"definition": "The code(s) that detail the conditions under which the healthcare service is available/offered."
}, {
"id": "HealthcareService.eligibility",
"path": "HealthcareService.eligibility",
"type": [ {
"code": "BackboneElement"
} ],
"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?"
}, {
"id": "HealthcareService.eligibility.code",
"max": "1",
"path": "HealthcareService.eligibility.code",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Coded value for the eligibility",
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceEligibility"
} ],
"description": "Coded values underwhich a specific service is made available."
},
"mapping": [ {
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]",
"identity": "rim"
} ],
"definition": "Coded value for the eligibility."
}, {
"id": "HealthcareService.eligibility.comment",
"max": "1",
"path": "HealthcareService.eligibility.comment",
"type": [ {
"code": "markdown"
} ],
"short": "Describes the eligibility conditions for the service",
"comment": "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.",
"mapping": [ {
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text",
"identity": "rim"
} ],
"definition": "Describes the eligibility conditions for the service."
}, {
"id": "HealthcareService.program",
"path": "HealthcareService.program",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Programs that this service is applicable to",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/program",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Program"
} ],
"description": "Government or local programs that this service applies to."
},
"comment": "Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….",
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
} ],
"definition": "Programs that this service is applicable to."
}, {
"id": "HealthcareService.characteristic",
"path": "HealthcareService.characteristic",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Collection of characteristics (attributes)",
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceCharacteristic"
} ],
"description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy)."
},
"comment": "These could be such things as is wheelchair accessible.",
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
} ],
"definition": "Collection of characteristics (attributes)."
}, {
"id": "HealthcareService.communication",
"path": "HealthcareService.communication",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "The language that this service is offered in",
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"comment": "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.",
"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."
}, {
"id": "HealthcareService.referralMethod",
"path": "HealthcareService.referralMethod",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Ways that the service accepts referrals",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/service-referral-method",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferralMethod"
} ],
"description": "The methods of referral can be used when referring to a specific HealthCareService resource."
},
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
} ],
"definition": "Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required."
}, {
"id": "HealthcareService.appointmentRequired",
"max": "1",
"path": "HealthcareService.appointmentRequired",
"type": [ {
"code": "boolean"
} ],
"short": "If an appointment is required for access to this service",
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
} ],
"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."
}, {
"id": "HealthcareService.availableTime",
"path": "HealthcareService.availableTime",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Times the Service Site is available",
"comment": "More detailed availability information may be provided in associated Schedule/Slot resources.",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"definition": "A collection of times that the Service Site is available."
}, {
"id": "HealthcareService.availableTime.daysOfWeek",
"path": "HealthcareService.availableTime.daysOfWeek",
"type": [ {
"code": "code"
} ],
"short": "mon | tue | wed | thu | fri | sat | sun",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DaysOfWeek"
} ],
"description": "The days of the week."
},
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"definition": "Indicates which days of the week are available between the start and end Times."
}, {
"id": "HealthcareService.availableTime.allDay",
"max": "1",
"path": "HealthcareService.availableTime.allDay",
"type": [ {
"code": "boolean"
} ],
"short": "Always available? e.g. 24 hour service",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"definition": "Is this always available? (hence times are irrelevant) e.g. 24 hour service."
}, {
"id": "HealthcareService.availableTime.availableStartTime",
"max": "1",
"path": "HealthcareService.availableTime.availableStartTime",
"type": [ {
"code": "time"
} ],
"short": "Opening time of day (ignored if allDay = true)",
"comment": "The time zone is expected to be for where this HealthcareService is provided at.",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored."
}, {
"id": "HealthcareService.availableTime.availableEndTime",
"max": "1",
"path": "HealthcareService.availableTime.availableEndTime",
"type": [ {
"code": "time"
} ],
"short": "Closing time of day (ignored if allDay = true)",
"comment": "The time zone is expected to be for where this HealthcareService is provided at.",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored."
}, {
"id": "HealthcareService.notAvailable",
"path": "HealthcareService.notAvailable",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Not available during this time due to provided reason",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"definition": "The HealthcareService is not available during this period of time due to the provided reason."
}, {
"id": "HealthcareService.notAvailable.description",
"max": "1",
"min": 1,
"path": "HealthcareService.notAvailable.description",
"type": [ {
"code": "string"
} ],
"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."
}, {
"id": "HealthcareService.notAvailable.during",
"max": "1",
"path": "HealthcareService.notAvailable.during",
"type": [ {
"code": "Period"
} ],
"short": "Service not available from this date",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"definition": "Service is not available (seasonally or for a public holiday) from this date."
}, {
"id": "HealthcareService.availabilityExceptions",
"max": "1",
"path": "HealthcareService.availabilityExceptions",
"type": [ {
"code": "string"
} ],
"short": "Description of availability exceptions",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"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."
}, {
"id": "HealthcareService.endpoint",
"path": "HealthcareService.endpoint",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/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."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}