STU 3 Ballot
AdministrationThis page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
StructureDefinition for healthcareservice
{
"resourceType": "StructureDefinition",
"id": "HealthcareService",
"meta": {
"lastUpdated": "2016-08-11T17:02:54.322+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/HealthcareService",
"name": "HealthcareService",
"status": "draft",
"publisher": "Health Level Seven International (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"date": "2016-08-11T17:02:54+10:00",
"description": "Base StructureDefinition for HealthcareService Resource",
"fhirVersion": "1.6.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "HealthcareService",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "HealthcareService",
"path": "HealthcareService",
"short": "The details of a healthcare service available at a location",
"definition": "The details of a healthcare service available at a location.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "act[classCode=ACT][moodCode=DEF]"
},
{
"identity": "w5",
"map": "administrative.group"
}
]
},
{
"id": "HealthcareService.id",
"path": "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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "HealthcareService.meta",
"path": "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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "HealthcareService.implicitRules",
"path": "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.",
"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 as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "HealthcareService.language",
"path": "HealthcareService.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "HealthcareService.text",
"path": "HealthcareService.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"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 in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "HealthcareService.contained",
"path": "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.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.extension",
"path": "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. In order 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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.modifierExtension",
"path": "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. Usually modifier elements provide negation or qualification. In order 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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.identifier",
"path": "HealthcareService.identifier",
"short": "External identifiers for this item",
"definition": "External identifiers for this item.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "HealthcareService.active",
"path": "HealthcareService.active",
"short": "Whether this healthcareservice is in active use",
"definition": "Whether this healthcareservice record is in active use.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": true,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "HealthcareService.providedBy",
"path": "HealthcareService.providedBy",
"short": "Organization that provides this service",
"definition": "The organization that provides this healthcare service.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".scopingRole.Organization"
}
]
},
{
"id": "HealthcareService.serviceCategory",
"path": "HealthcareService.serviceCategory",
"short": "Broad category of service being performed or delivered",
"definition": "Identifies the broad category of service being performed or delivered.",
"comments": "Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A category of the service(s) that could be provided.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "HealthcareService.serviceType",
"path": "HealthcareService.serviceType",
"short": "Type of service that may be delivered or performed",
"definition": "The specific type of service that may be delivered or performed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Additional details about where the content was created (e.g. clinical specialty).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code"
}
]
},
{
"id": "HealthcareService.specialty",
"path": "HealthcareService.specialty",
"short": "Specialties handled by the HealthcareService",
"definition": "Collection of specialties handled by the service site. This is more of a medical term.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "A specialty that a healthcare service may provide.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code"
}
]
},
{
"id": "HealthcareService.location",
"path": "HealthcareService.location",
"short": "Location(s) where service may be provided",
"definition": "The location(s) where this healthcare service may be provided.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".location.role[classCode=SDLOC]"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "HealthcareService.serviceName",
"path": "HealthcareService.serviceName",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".name"
}
]
},
{
"id": "HealthcareService.comment",
"path": "HealthcareService.comment",
"short": "Additional description and/or any specific issues not covered elsewhere",
"definition": "Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".location.role[classCode=SDLOC].desc"
}
]
},
{
"id": "HealthcareService.extraDetails",
"path": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text"
}
]
},
{
"id": "HealthcareService.photo",
"path": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Attachment"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=SBJ].observation.value"
}
]
},
{
"id": "HealthcareService.telecom",
"path": "HealthcareService.telecom",
"short": "Contacts related to the healthcare service",
"definition": "List of contacts related to this specific healthcare service.",
"comments": "If this is empty, then refer to the location's contacts.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "rim",
"map": ".telecom"
}
]
},
{
"id": "HealthcareService.coverageArea",
"path": "HealthcareService.coverageArea",
"short": "Location(s) service is inteded for/available to",
"definition": "The location(s) that this service is available to (not where the service is provided).",
"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\".",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate"
}
]
},
{
"id": "HealthcareService.serviceProvisionCode",
"path": "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.",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "The code(s) that detail the conditions under which the healthcare service is available/offered.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-provision-conditions"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]"
}
]
},
{
"id": "HealthcareService.eligibility",
"path": "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?",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Coded values underwhich a specific service is made available."
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]"
}
]
},
{
"id": "HealthcareService.eligibilityNote",
"path": "HealthcareService.eligibilityNote",
"short": "Describes the eligibility conditions for the service",
"definition": "Describes the eligibility conditions for the service.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text"
}
]
},
{
"id": "HealthcareService.programName",
"path": "HealthcareService.programName",
"short": "Program Names that categorize the service",
"definition": "Program Names that can be used to categorize the service.",
"comments": "Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PERT].observation"
}
]
},
{
"id": "HealthcareService.characteristic",
"path": "HealthcareService.characteristic",
"short": "Collection of characteristics (attributes)",
"definition": "Collection of characteristics (attributes).",
"comments": "These could be such things as is wheelchair accessible.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy)."
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PERT].observation"
}
]
},
{
"id": "HealthcareService.referralMethod",
"path": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "The methods of referral can be used when referring to a specific HealthCareService resource.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-referral-method"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PERT].observation"
}
]
},
{
"id": "HealthcareService.publicKey",
"path": "HealthcareService.publicKey",
"short": "PKI Public keys to support secure communications",
"definition": "The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available.",
"comments": "Note: This is a base64 encoded digital certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".certificateText"
}
]
},
{
"id": "HealthcareService.appointmentRequired",
"path": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PERT].observation"
}
]
},
{
"id": "HealthcareService.availableTime",
"path": "HealthcareService.availableTime",
"short": "Times the Service Site is available",
"definition": "A collection of times that the Service Site is available.",
"comments": "More detailed availability information may be provided in associated Schedule/Slot resources.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.availableTime.id",
"path": "HealthcareService.availableTime.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.availableTime.extension",
"path": "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. In order 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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.availableTime.modifierExtension",
"path": "HealthcareService.availableTime.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.availableTime.daysOfWeek",
"path": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The days of the week.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/days-of-week"
}
},
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.availableTime.allDay",
"path": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.availableTime.availableStartTime",
"path": "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.",
"comments": "The timezone is expected to be for where this HealthcareService is provided at.",
"min": 0,
"max": "1",
"type": [
{
"code": "time"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.availableTime.availableEndTime",
"path": "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.",
"comments": "The timezone is expected to be for where this HealthcareService is provided at.",
"min": 0,
"max": "1",
"type": [
{
"code": "time"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.notAvailable",
"path": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.notAvailable.id",
"path": "HealthcareService.notAvailable.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.notAvailable.extension",
"path": "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. In order 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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.notAvailable.modifierExtension",
"path": "HealthcareService.notAvailable.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.notAvailable.description",
"path": "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.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.notAvailable.during",
"path": "HealthcareService.notAvailable.during",
"short": "Service not availablefrom this date",
"definition": "Service is not available (seasonally or for a public holiday) from this date.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.availabilityExceptions",
"path": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
}
]
},
"differential": {
"element": [
{
"id": "HealthcareService",
"path": "HealthcareService",
"short": "The details of a healthcare service available at a location",
"definition": "The details of a healthcare service available at a location.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "act[classCode=ACT][moodCode=DEF]"
},
{
"identity": "w5",
"map": "administrative.group"
}
]
},
{
"id": "HealthcareService.identifier",
"path": "HealthcareService.identifier",
"short": "External identifiers for this item",
"definition": "External identifiers for this item.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "HealthcareService.active",
"path": "HealthcareService.active",
"short": "Whether this healthcareservice is in active use",
"definition": "Whether this healthcareservice record is in active use.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": true,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "HealthcareService.providedBy",
"path": "HealthcareService.providedBy",
"short": "Organization that provides this service",
"definition": "The organization that provides this healthcare service.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".scopingRole.Organization"
}
]
},
{
"id": "HealthcareService.serviceCategory",
"path": "HealthcareService.serviceCategory",
"short": "Broad category of service being performed or delivered",
"definition": "Identifies the broad category of service being performed or delivered.",
"comments": "Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A category of the service(s) that could be provided.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "HealthcareService.serviceType",
"path": "HealthcareService.serviceType",
"short": "Type of service that may be delivered or performed",
"definition": "The specific type of service that may be delivered or performed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Additional details about where the content was created (e.g. clinical specialty).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code"
}
]
},
{
"id": "HealthcareService.specialty",
"path": "HealthcareService.specialty",
"short": "Specialties handled by the HealthcareService",
"definition": "Collection of specialties handled by the service site. This is more of a medical term.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "A specialty that a healthcare service may provide.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code"
}
]
},
{
"id": "HealthcareService.location",
"path": "HealthcareService.location",
"short": "Location(s) where service may be provided",
"definition": "The location(s) where this healthcare service may be provided.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".location.role[classCode=SDLOC]"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "HealthcareService.serviceName",
"path": "HealthcareService.serviceName",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".name"
}
]
},
{
"id": "HealthcareService.comment",
"path": "HealthcareService.comment",
"short": "Additional description and/or any specific issues not covered elsewhere",
"definition": "Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".location.role[classCode=SDLOC].desc"
}
]
},
{
"id": "HealthcareService.extraDetails",
"path": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text"
}
]
},
{
"id": "HealthcareService.photo",
"path": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Attachment"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=SBJ].observation.value"
}
]
},
{
"id": "HealthcareService.telecom",
"path": "HealthcareService.telecom",
"short": "Contacts related to the healthcare service",
"definition": "List of contacts related to this specific healthcare service.",
"comments": "If this is empty, then refer to the location's contacts.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "rim",
"map": ".telecom"
}
]
},
{
"id": "HealthcareService.coverageArea",
"path": "HealthcareService.coverageArea",
"short": "Location(s) service is inteded for/available to",
"definition": "The location(s) that this service is available to (not where the service is provided).",
"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\".",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate"
}
]
},
{
"id": "HealthcareService.serviceProvisionCode",
"path": "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.",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "The code(s) that detail the conditions under which the healthcare service is available/offered.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-provision-conditions"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]"
}
]
},
{
"id": "HealthcareService.eligibility",
"path": "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?",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Coded values underwhich a specific service is made available."
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]"
}
]
},
{
"id": "HealthcareService.eligibilityNote",
"path": "HealthcareService.eligibilityNote",
"short": "Describes the eligibility conditions for the service",
"definition": "Describes the eligibility conditions for the service.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text"
}
]
},
{
"id": "HealthcareService.programName",
"path": "HealthcareService.programName",
"short": "Program Names that categorize the service",
"definition": "Program Names that can be used to categorize the service.",
"comments": "Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PERT].observation"
}
]
},
{
"id": "HealthcareService.characteristic",
"path": "HealthcareService.characteristic",
"short": "Collection of characteristics (attributes)",
"definition": "Collection of characteristics (attributes).",
"comments": "These could be such things as is wheelchair accessible.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy)."
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PERT].observation"
}
]
},
{
"id": "HealthcareService.referralMethod",
"path": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "The methods of referral can be used when referring to a specific HealthCareService resource.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-referral-method"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PERT].observation"
}
]
},
{
"id": "HealthcareService.publicKey",
"path": "HealthcareService.publicKey",
"short": "PKI Public keys to support secure communications",
"definition": "The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available.",
"comments": "Note: This is a base64 encoded digital certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".certificateText"
}
]
},
{
"id": "HealthcareService.appointmentRequired",
"path": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PERT].observation"
}
]
},
{
"id": "HealthcareService.availableTime",
"path": "HealthcareService.availableTime",
"short": "Times the Service Site is available",
"definition": "A collection of times that the Service Site is available.",
"comments": "More detailed availability information may be provided in associated Schedule/Slot resources.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.availableTime.daysOfWeek",
"path": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The days of the week.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/days-of-week"
}
},
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.availableTime.allDay",
"path": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.availableTime.availableStartTime",
"path": "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.",
"comments": "The timezone is expected to be for where this HealthcareService is provided at.",
"min": 0,
"max": "1",
"type": [
{
"code": "time"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.availableTime.availableEndTime",
"path": "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.",
"comments": "The timezone is expected to be for where this HealthcareService is provided at.",
"min": 0,
"max": "1",
"type": [
{
"code": "time"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.notAvailable",
"path": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.notAvailable.description",
"path": "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.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.notAvailable.during",
"path": "HealthcareService.notAvailable.during",
"short": "Service not availablefrom this date",
"definition": "Service is not available (seasonally or for a public holiday) from this date.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.availabilityExceptions",
"path": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change