FHIR IG analytics| Package | hl7.fhir.uv.xver-r4b.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-profile-HealthcareService.json |
| FHIR Version | R3 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition profile-HealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |
  meta | ||||
   Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:meta | 0..1 | Meta | R4B: meta additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.meta | |
| text | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:text | 0..1 | (Complex) | R4B: text additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.text | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:program | 0..* | CodeableConcept | R4B: Programs that this service is applicable to (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.program Binding: R4BProgramForR3 (0.1.0) (example): Government or local programs that this service applies to. | |
| extension:communication | 0..* | CodeableConcept | R4B: The language that this service is offered in (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.communication | |
| identifier | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:identifier | 0..* | Identifier | R4B: identifier additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.identifier | |
| providedBy | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:providedBy | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: providedBy additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| location | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:location | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: location additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| photo | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:photo | 0..1 | Attachment | R4B: photo additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.photo | |
| telecom | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:telecom | 0..* | ContactPoint | R4B: telecom additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.telecom | |
| coverageArea | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:coverageArea | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: Location(s) service is intended for/available to additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| notAvailable | ||||
| during | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:during | 0..1 | Period | R4B: Service not available from this date additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.notAvailable.during | |
| endpoint | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:endpoint | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: Technical endpoints providing access to electronic services operated for the healthcare service additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "profile-HealthcareService",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r4b.r3"
},
{
"url": "version",
"valueString": "0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.3/StructureDefinition/profile-HealthcareService",
"version": "0.1.0",
"name": "Profile_R4B_HealthcareService_R3",
"title": "Cross-version Profile for R4B.HealthcareService for use in FHIR STU3",
"status": "active",
"experimental": false,
"date": "2026-03-17T16:04:25.0233773-05:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "This cross-version profile allows R4B HealthcareService content to be represented via FHIR STU3 HealthcareService resources.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "3.0.2",
"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/HealthcareService",
"derivation": "constraint",
"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": "*",
"base": {
"path": "HealthcareService",
"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)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"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)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"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))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"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))]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"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.",
"comment": "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": "1"
},
"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": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "HealthcareService.meta.id",
"path": "HealthcareService.meta.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.meta.extension",
"path": "HealthcareService.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "HealthcareService.meta.extension:meta",
"path": "HealthcareService.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `HealthcareService.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `HealthcareService.meta` is mapped to FHIR STU3 element `HealthcareService.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.meta` do not cover the following types: Meta.\nThe mappings for `HealthcareService.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.meta|0.1.0"
}
]
},
{
"id": "HealthcareService.meta.versionId",
"path": "HealthcareService.meta.versionId",
"short": "Version specific identifier",
"definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.versionId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "HealthcareService.meta.lastUpdated",
"path": "HealthcareService.meta.lastUpdated",
"short": "When the resource version last changed",
"definition": "When the resource last changed - e.g. when the version changed.",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.lastUpdated",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"isSummary": true
},
{
"id": "HealthcareService.meta.profile",
"path": "HealthcareService.meta.profile",
"short": "Profiles this resource claims to conform to",
"definition": "A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/STU3/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/STU3/).",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.profile",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "HealthcareService.meta.security",
"path": "HealthcareService.meta.security",
"short": "Security Labels applied to this resource",
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.security",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}
],
"strength": "extensible",
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels|3.0.2"
}
}
},
{
"id": "HealthcareService.meta.tag",
"path": "HealthcareService.meta.tag",
"short": "Tags applied to this resource",
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.tag",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
}
],
"strength": "example",
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/common-tags|3.0.2"
}
}
},
{
"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.",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"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.",
"comment": "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": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages|3.0.2"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages|3.0.2"
}
}
},
{
"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.",
"comment": "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": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "HealthcareService.text.id",
"path": "HealthcareService.text.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.text.extension",
"path": "HealthcareService.text.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "HealthcareService.text.extension:text",
"path": "HealthcareService.text.extension",
"sliceName": "text",
"short": "R4B: text additional types",
"definition": "R4B: `HealthcareService.text` additional types (Narrative) additional types from child elements (div, status)",
"comment": "Element `HealthcareService.text` is mapped to FHIR STU3 element `HealthcareService.text` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.text` do not cover the following types: Narrative.\nThe mappings for `HealthcareService.text` do not cover the following types based on type expansion: div, status.\nContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.text|0.1.0"
}
]
},
{
"id": "HealthcareService.text.status",
"path": "HealthcareService.text.status",
"short": "generated | extensions | additional | empty",
"definition": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.",
"min": 1,
"max": "1",
"base": {
"path": "Narrative.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NarrativeStatus"
}
],
"strength": "required",
"description": "The status of a resource narrative",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/narrative-status|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.text.div",
"path": "HealthcareService.text.div",
"short": "Limited xhtml content",
"definition": "The actual narrative content, a stripped down version of XHTML.",
"comment": "The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.",
"min": 1,
"max": "1",
"base": {
"path": "Narrative.div",
"min": 1,
"max": "1"
},
"type": [
{
"code": "xhtml"
}
],
"constraint": [
{
"key": "txt-1",
"severity": "error",
"human": "The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes",
"expression": "htmlchecks()",
"xpath": "not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))]) and not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])",
"source": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
},
{
"key": "txt-2",
"severity": "error",
"human": "The narrative SHALL have some non-whitespace content",
"expression": "htmlchecks()",
"xpath": "descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]",
"source": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"comment": "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",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "HealthcareService.extension:program",
"path": "HealthcareService.extension",
"sliceName": "program",
"short": "R4B: Programs that this service is applicable to (new)",
"definition": "R4B: `HealthcareService.program` (new:CodeableConcept)",
"comment": "Element `HealthcareService.program` has a context of HealthcareService based on following the parent source element upwards and mapping to `HealthcareService`.\nElement `HealthcareService.program` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nPrograms are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.program|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "HealthcareService.extension:communication",
"path": "HealthcareService.extension",
"sliceName": "communication",
"short": "R4B: The language that this service is offered in (new)",
"definition": "R4B: `HealthcareService.communication` (new:CodeableConcept)",
"comment": "Element `HealthcareService.communication` has a context of HealthcareService based on following the parent source element upwards and mapping to `HealthcareService`.\nElement `HealthcareService.communication` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nWhen 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.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.communication|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"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.",
"comment": "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": "*",
"base": {
"path": "HealthcareService.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "HealthcareService.identifier.id",
"path": "HealthcareService.identifier.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.identifier.extension",
"path": "HealthcareService.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "HealthcareService.identifier.extension:identifier",
"path": "HealthcareService.identifier.extension",
"sliceName": "identifier",
"short": "R4B: identifier additional types",
"definition": "R4B: `HealthcareService.identifier` additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)",
"comment": "Element `HealthcareService.identifier` is mapped to FHIR STU3 element `HealthcareService.identifier` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.identifier` do not cover the following types: Identifier.\nThe mappings for `HealthcareService.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.identifier|0.1.0"
}
]
},
{
"id": "HealthcareService.identifier.use",
"path": "HealthcareService.identifier.use",
"short": "usual | official | temp | secondary (If known)",
"definition": "The purpose of this identifier.",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "HealthcareService.identifier.type",
"path": "HealthcareService.identifier.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "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. \n\nWhere 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.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "HealthcareService.identifier.system",
"path": "HealthcareService.identifier.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"requirements": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "HealthcareService.identifier.value",
"path": "HealthcareService.identifier.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "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 [Rendered Value extension](http://hl7.org/fhir/STU3/extension-rendered-value.html).",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "HealthcareService.identifier.period",
"path": "HealthcareService.identifier.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "HealthcareService.identifier.assigner",
"path": "HealthcareService.identifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"id": "HealthcareService.active",
"path": "HealthcareService.active",
"short": "Whether this healthcareservice is in active use",
"definition": "Whether this healthcareservice record is in active use.",
"comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"min": 0,
"max": "1",
"base": {
"path": "HealthcareService.active",
"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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "HealthcareService.providedBy",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".scopingRole.Organization"
}
]
},
{
"id": "HealthcareService.providedBy.id",
"path": "HealthcareService.providedBy.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.providedBy.extension",
"path": "HealthcareService.providedBy.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "HealthcareService.providedBy.extension:providedBy",
"path": "HealthcareService.providedBy.extension",
"sliceName": "providedBy",
"short": "R4B: providedBy additional types",
"definition": "R4B: `HealthcareService.providedBy` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `HealthcareService.providedBy` is mapped to FHIR STU3 element `HealthcareService.providedBy` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.providedBy` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `HealthcareService.providedBy` with unmapped reference targets: Organization.\nThis 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",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "HealthcareService.providedBy.reference",
"path": "HealthcareService.providedBy.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.providedBy.identifier",
"path": "HealthcareService.providedBy.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "HealthcareService.providedBy.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "HealthcareService.providedBy.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.category",
"path": "HealthcareService.category",
"short": "Broad category of service being performed or delivered",
"definition": "Identifies the broad category of service being performed or delivered.",
"comment": "Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.",
"alias": [
"service category"
],
"min": 0,
"max": "1",
"base": {
"path": "HealthcareService.category",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-category"
}
],
"strength": "example",
"description": "A category of the service(s) that could be provided.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-category|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "HealthcareService.type",
"path": "HealthcareService.type",
"short": "Type of service that may be delivered or performed",
"definition": "The specific type of service that may be delivered or performed.",
"alias": [
"service type"
],
"min": 0,
"max": "*",
"base": {
"path": "HealthcareService.type",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-type"
}
],
"strength": "example",
"description": "Additional details about where the content was created (e.g. clinical specialty).",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-type|3.0.2"
}
},
"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": "*",
"base": {
"path": "HealthcareService.specialty",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-specialty"
}
],
"strength": "preferred",
"description": "A specialty that a healthcare service may provide.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes|20091109"
}
},
"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": "*",
"base": {
"path": "HealthcareService.location",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".location.role[classCode=SDLOC]"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "HealthcareService.location.id",
"path": "HealthcareService.location.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.location.extension",
"path": "HealthcareService.location.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "HealthcareService.location.extension:location",
"path": "HealthcareService.location.extension",
"sliceName": "location",
"short": "R4B: location additional types",
"definition": "R4B: `HealthcareService.location` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `HealthcareService.location` is mapped to FHIR STU3 element `HealthcareService.location` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.location` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `HealthcareService.location` with unmapped reference targets: Location.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "HealthcareService.location.reference",
"path": "HealthcareService.location.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.location.identifier",
"path": "HealthcareService.location.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "HealthcareService.location.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "HealthcareService.location.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.name",
"path": "HealthcareService.name",
"short": "Description of service as presented to a consumer while searching",
"definition": "Further description of the service as it would be presented to a consumer while searching.",
"min": 0,
"max": "1",
"base": {
"path": "HealthcareService.name",
"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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "HealthcareService.comment",
"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",
"base": {
"path": "HealthcareService.extraDetails",
"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",
"base": {
"path": "HealthcareService.photo",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Attachment"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=SBJ].observation.value"
}
]
},
{
"id": "HealthcareService.photo.id",
"path": "HealthcareService.photo.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.photo.extension",
"path": "HealthcareService.photo.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "HealthcareService.photo.extension:photo",
"path": "HealthcareService.photo.extension",
"sliceName": "photo",
"short": "R4B: photo additional types",
"definition": "R4B: `HealthcareService.photo` additional types (Attachment) additional types from child elements (contentType, creation, data, hash, language, size, title, url)",
"comment": "Element `HealthcareService.photo` is mapped to FHIR STU3 element `HealthcareService.photo` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.photo` do not cover the following types: Attachment.\nThe mappings for `HealthcareService.photo` do not cover the following types based on type expansion: contentType, creation, data, hash, language, size, title, url.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.photo|0.1.0"
}
]
},
{
"id": "HealthcareService.photo.contentType",
"path": "HealthcareService.photo.contentType",
"short": "Mime type of the content, with charset etc.",
"definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"requirements": "Processors of the data need to be able to know how to interpret the data.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.contentType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"example": [
{
"label": "General",
"valueCode": "text/plain; charset=UTF-8, image/png"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}
],
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"mapping": [
{
"identity": "v2",
"map": "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used"
},
{
"identity": "rim",
"map": "./mediaType, ./charset"
}
]
},
{
"id": "HealthcareService.photo.language",
"path": "HealthcareService.photo.language",
"short": "Human language of the content (BCP-47)",
"definition": "The human language of the content. The value can be any valid value according to BCP 47.",
"requirements": "Users need to be able to choose between the languages in a set of attachments.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"example": [
{
"label": "General",
"valueCode": "en-AU"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages|3.0.2"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "./language"
}
]
},
{
"id": "HealthcareService.photo.data",
"path": "HealthcareService.photo.data",
"short": "Data inline, base64ed",
"definition": "The actual data of the attachment - a sequence of bytes. In XML, represented using base64.",
"comment": "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.",
"requirements": "The data needs to able to be transmitted inline.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.data",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
}
],
"mapping": [
{
"identity": "v2",
"map": "ED.5"
},
{
"identity": "rim",
"map": "./data"
}
]
},
{
"id": "HealthcareService.photo.url",
"path": "HealthcareService.photo.url",
"short": "Uri where the data can be found",
"definition": "An alternative location where the data can be accessed.",
"comment": "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.",
"requirements": "The data needs to be transmitted by reference.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/logo-small.png"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RP.1+RP.2 - if they refer to a URL (see v2.6)"
},
{
"identity": "rim",
"map": "./reference/literal"
}
]
},
{
"id": "HealthcareService.photo.size",
"path": "HealthcareService.photo.size",
"short": "Number of bytes of content (if url provided)",
"definition": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
"comment": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.size",
"min": 0,
"max": "1"
},
"type": [
{
"code": "unsignedInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (needs data type R3 proposal)"
}
]
},
{
"id": "HealthcareService.photo.hash",
"path": "HealthcareService.photo.hash",
"short": "Hash of the data (sha-1, base64ed)",
"definition": "The calculated hash of the data using SHA-1. Represented using base64.",
"comment": "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded.",
"requirements": "Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.hash",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".integrityCheck[parent::ED/integrityCheckAlgorithm=\"SHA-1\"]"
}
]
},
{
"id": "HealthcareService.photo.title",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "HealthcareService.photo.title",
"short": "Label to display in place of the data",
"definition": "A label or set of text to display in place of the data.",
"requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.title",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "Official Corporate Logo"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./title/data"
}
]
},
{
"id": "HealthcareService.photo.creation",
"path": "HealthcareService.photo.creation",
"short": "Date attachment was first created",
"definition": "The date that the attachment was first created.",
"requirements": "This is often tracked as an integrity issue for use of the attachment.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.creation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (needs data type R3 proposal)"
}
]
},
{
"id": "HealthcareService.telecom",
"path": "HealthcareService.telecom",
"short": "Contacts related to the healthcare service",
"definition": "List of contacts related to this specific healthcare service.",
"comment": "If this is empty, then refer to the location's contacts.",
"min": 0,
"max": "*",
"base": {
"path": "HealthcareService.telecom",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "rim",
"map": ".telecom"
}
]
},
{
"id": "HealthcareService.telecom.id",
"path": "HealthcareService.telecom.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.telecom.extension",
"path": "HealthcareService.telecom.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "HealthcareService.telecom.extension:telecom",
"path": "HealthcareService.telecom.extension",
"sliceName": "telecom",
"short": "R4B: telecom additional types",
"definition": "R4B: `HealthcareService.telecom` additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)",
"comment": "Element `HealthcareService.telecom` is mapped to FHIR STU3 element `HealthcareService.telecom` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.telecom` do not cover the following types: ContactPoint.\nThe mappings for `HealthcareService.telecom` do not cover the following types based on type expansion: period, rank, system, use, value.\nIf this is empty, then refer to the location's contacts.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.telecom|0.1.0"
}
]
},
{
"id": "HealthcareService.telecom.system",
"path": "HealthcareService.telecom.system",
"short": "phone | fax | email | pager | url | sms | other",
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"cpt-2"
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointSystem"
}
],
"strength": "required",
"description": "Telecommunications form for contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-system|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "XTN.3"
},
{
"identity": "rim",
"map": "./scheme"
},
{
"identity": "servd",
"map": "./ContactPointType"
}
]
},
{
"id": "HealthcareService.telecom.value",
"path": "HealthcareService.telecom.value",
"short": "The actual contact point details",
"definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"requirements": "Need to support legacy numbers that are not in a tightly controlled format.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XTN.1 (or XTN.12)"
},
{
"identity": "rim",
"map": "./url"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "HealthcareService.telecom.use",
"path": "HealthcareService.telecom.use",
"short": "home | work | temp | old | mobile - purpose of this contact point",
"definition": "Identifies the purpose for the contact point.",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointUse"
}
],
"strength": "required",
"description": "Use of contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-use|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "XTN.2 - but often indicated by field"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./ContactPointPurpose"
}
]
},
{
"id": "HealthcareService.telecom.rank",
"path": "HealthcareService.telecom.rank",
"short": "Specify preferred order of use (1 = highest)",
"definition": "Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.rank",
"min": 0,
"max": "1"
},
"type": [
{
"code": "positiveInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.telecom.period",
"path": "HealthcareService.telecom.period",
"short": "Time period when the contact point was/is in use",
"definition": "Time period when the contact point was/is in use.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./usablePeriod[type=\"IVL<TS>\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"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).",
"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\".",
"min": 0,
"max": "*",
"base": {
"path": "HealthcareService.coverageArea",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate"
}
]
},
{
"id": "HealthcareService.coverageArea.id",
"path": "HealthcareService.coverageArea.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.coverageArea.extension",
"path": "HealthcareService.coverageArea.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "HealthcareService.coverageArea.extension:coverageArea",
"path": "HealthcareService.coverageArea.extension",
"sliceName": "coverageArea",
"short": "R4B: Location(s) service is intended for/available to additional types",
"definition": "R4B: `HealthcareService.coverageArea` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `HealthcareService.coverageArea` is mapped to FHIR STU3 element `HealthcareService.coverageArea` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.coverageArea` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `HealthcareService.coverageArea` with unmapped reference targets: Location.\nThe 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": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "HealthcareService.coverageArea.reference",
"path": "HealthcareService.coverageArea.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.coverageArea.identifier",
"path": "HealthcareService.coverageArea.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "HealthcareService.coverageArea.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "HealthcareService.coverageArea.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "HealthcareService.serviceProvisionCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProvisionConditions"
}
],
"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|3.0.2"
}
},
"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",
"base": {
"path": "HealthcareService.eligibility",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceEligibility"
}
],
"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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "HealthcareService.eligibilityNote",
"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.",
"comment": "Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….",
"min": 0,
"max": "*",
"base": {
"path": "HealthcareService.programName",
"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).",
"comment": "These could be such things as is wheelchair accessible.",
"min": 0,
"max": "*",
"base": {
"path": "HealthcareService.characteristic",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceCharacteristic"
}
],
"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": "*",
"base": {
"path": "HealthcareService.referralMethod",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferralMethod"
}
],
"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|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actrelationship[typeCode=PERT].observation"
}
]
},
{
"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",
"base": {
"path": "HealthcareService.appointmentRequired",
"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.",
"comment": "More detailed availability information may be provided in associated Schedule/Slot resources.",
"min": 0,
"max": "*",
"base": {
"path": "HealthcareService.availableTime",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"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": "1"
},
"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.",
"comment": "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.",
"comment": "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": "*",
"base": {
"path": "HealthcareService.availableTime.daysOfWeek",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DaysOfWeek"
}
],
"strength": "required",
"description": "The days of the week.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/days-of-week|3.0.2"
}
},
"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",
"base": {
"path": "HealthcareService.availableTime.allDay",
"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.",
"comment": "The timezone is expected to be for where this HealthcareService is provided at.",
"min": 0,
"max": "1",
"base": {
"path": "HealthcareService.availableTime.availableStartTime",
"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.",
"comment": "The timezone is expected to be for where this HealthcareService is provided at.",
"min": 0,
"max": "1",
"base": {
"path": "HealthcareService.availableTime.availableEndTime",
"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": "*",
"base": {
"path": "HealthcareService.notAvailable",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"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": "1"
},
"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.",
"comment": "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.",
"comment": "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",
"base": {
"path": "HealthcareService.notAvailable.description",
"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",
"base": {
"path": "HealthcareService.notAvailable.during",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.notAvailable.during.id",
"path": "HealthcareService.notAvailable.during.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.notAvailable.during.extension",
"path": "HealthcareService.notAvailable.during.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "HealthcareService.notAvailable.during.extension:during",
"path": "HealthcareService.notAvailable.during.extension",
"sliceName": "during",
"short": "R4B: Service not available from this date additional types",
"definition": "R4B: `HealthcareService.notAvailable.during` additional types (Period) additional types from child elements (end, start)",
"comment": "Element `HealthcareService.notAvailable.during` is mapped to FHIR STU3 element `HealthcareService.notAvailable.during` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.notAvailable.during` do not cover the following types: Period.\nThe mappings for `HealthcareService.notAvailable.during` do not cover the following types based on type expansion: end, start.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.notAvailable.during|0.1.0"
}
]
},
{
"id": "HealthcareService.notAvailable.during.start",
"path": "HealthcareService.notAvailable.during.start",
"short": "Starting time with inclusive boundary",
"definition": "The start of the period. The boundary is inclusive.",
"comment": "If the low element is missing, the meaning is that the low boundary is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Period.start",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"condition": [
"per-1"
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "DR.1"
},
{
"identity": "rim",
"map": "./low"
}
]
},
{
"id": "HealthcareService.notAvailable.during.end",
"path": "HealthcareService.notAvailable.during.end",
"short": "End time with inclusive boundary, if not ongoing",
"definition": "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.",
"min": 0,
"max": "1",
"base": {
"path": "Period.end",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing",
"condition": [
"per-1"
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "DR.2"
},
{
"identity": "rim",
"map": "./high"
}
]
},
{
"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",
"base": {
"path": "HealthcareService.availabilityExceptions",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "HealthcareService.endpoint",
"path": "HealthcareService.endpoint",
"short": "Technical endpoints providing access to services operated for the location",
"definition": "Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.",
"requirements": "Organizations may have different systems covering different services at the different locations and need to be able to define the technical connection details for how to connect to them, and for what purpose.",
"min": 0,
"max": "*",
"base": {
"path": "HealthcareService.endpoint",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.endpoint.id",
"path": "HealthcareService.endpoint.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "HealthcareService.endpoint.extension",
"path": "HealthcareService.endpoint.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "HealthcareService.endpoint.extension:endpoint",
"path": "HealthcareService.endpoint.extension",
"sliceName": "endpoint",
"short": "R4B: Technical endpoints providing access to electronic services operated for the healthcare service additional types",
"definition": "R4B: `HealthcareService.endpoint` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `HealthcareService.endpoint` is mapped to FHIR STU3 element `HealthcareService.endpoint` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.endpoint` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `HealthcareService.endpoint` with unmapped reference targets: Endpoint.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "HealthcareService.endpoint.reference",
"path": "HealthcareService.endpoint.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "HealthcareService.endpoint.identifier",
"path": "HealthcareService.endpoint.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "HealthcareService.endpoint.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "HealthcareService.endpoint.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "HealthcareService",
"path": "HealthcareService"
},
{
"id": "HealthcareService.meta.extension",
"path": "HealthcareService.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "HealthcareService.meta.extension:meta",
"path": "HealthcareService.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `HealthcareService.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `HealthcareService.meta` is mapped to FHIR STU3 element `HealthcareService.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.meta` do not cover the following types: Meta.\nThe mappings for `HealthcareService.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.meta|0.1.0"
}
]
},
{
"id": "HealthcareService.text.extension",
"path": "HealthcareService.text.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "HealthcareService.text.extension:text",
"path": "HealthcareService.text.extension",
"sliceName": "text",
"short": "R4B: text additional types",
"definition": "R4B: `HealthcareService.text` additional types (Narrative) additional types from child elements (div, status)",
"comment": "Element `HealthcareService.text` is mapped to FHIR STU3 element `HealthcareService.text` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.text` do not cover the following types: Narrative.\nThe mappings for `HealthcareService.text` do not cover the following types based on type expansion: div, status.\nContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.text|0.1.0"
}
]
},
{
"id": "HealthcareService.extension",
"path": "HealthcareService.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "HealthcareService.extension:program",
"path": "HealthcareService.extension",
"sliceName": "program",
"short": "R4B: Programs that this service is applicable to (new)",
"definition": "R4B: `HealthcareService.program` (new:CodeableConcept)",
"comment": "Element `HealthcareService.program` has a context of HealthcareService based on following the parent source element upwards and mapping to `HealthcareService`.\nElement `HealthcareService.program` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nPrograms are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.program|0.1.0"
}
]
},
{
"id": "HealthcareService.extension:communication",
"path": "HealthcareService.extension",
"sliceName": "communication",
"short": "R4B: The language that this service is offered in (new)",
"definition": "R4B: `HealthcareService.communication` (new:CodeableConcept)",
"comment": "Element `HealthcareService.communication` has a context of HealthcareService based on following the parent source element upwards and mapping to `HealthcareService`.\nElement `HealthcareService.communication` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nWhen 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.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.communication|0.1.0"
}
]
},
{
"id": "HealthcareService.identifier.extension",
"path": "HealthcareService.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "HealthcareService.identifier.extension:identifier",
"path": "HealthcareService.identifier.extension",
"sliceName": "identifier",
"short": "R4B: identifier additional types",
"definition": "R4B: `HealthcareService.identifier` additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)",
"comment": "Element `HealthcareService.identifier` is mapped to FHIR STU3 element `HealthcareService.identifier` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.identifier` do not cover the following types: Identifier.\nThe mappings for `HealthcareService.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.identifier|0.1.0"
}
]
},
{
"id": "HealthcareService.providedBy.extension",
"path": "HealthcareService.providedBy.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "HealthcareService.providedBy.extension:providedBy",
"path": "HealthcareService.providedBy.extension",
"sliceName": "providedBy",
"short": "R4B: providedBy additional types",
"definition": "R4B: `HealthcareService.providedBy` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `HealthcareService.providedBy` is mapped to FHIR STU3 element `HealthcareService.providedBy` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.providedBy` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `HealthcareService.providedBy` with unmapped reference targets: Organization.\nThis 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",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "HealthcareService.location.extension",
"path": "HealthcareService.location.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "HealthcareService.location.extension:location",
"path": "HealthcareService.location.extension",
"sliceName": "location",
"short": "R4B: location additional types",
"definition": "R4B: `HealthcareService.location` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `HealthcareService.location` is mapped to FHIR STU3 element `HealthcareService.location` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.location` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `HealthcareService.location` with unmapped reference targets: Location.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "HealthcareService.photo.extension",
"path": "HealthcareService.photo.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "HealthcareService.photo.extension:photo",
"path": "HealthcareService.photo.extension",
"sliceName": "photo",
"short": "R4B: photo additional types",
"definition": "R4B: `HealthcareService.photo` additional types (Attachment) additional types from child elements (contentType, creation, data, hash, language, size, title, url)",
"comment": "Element `HealthcareService.photo` is mapped to FHIR STU3 element `HealthcareService.photo` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.photo` do not cover the following types: Attachment.\nThe mappings for `HealthcareService.photo` do not cover the following types based on type expansion: contentType, creation, data, hash, language, size, title, url.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.photo|0.1.0"
}
]
},
{
"id": "HealthcareService.telecom.extension",
"path": "HealthcareService.telecom.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "HealthcareService.telecom.extension:telecom",
"path": "HealthcareService.telecom.extension",
"sliceName": "telecom",
"short": "R4B: telecom additional types",
"definition": "R4B: `HealthcareService.telecom` additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)",
"comment": "Element `HealthcareService.telecom` is mapped to FHIR STU3 element `HealthcareService.telecom` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.telecom` do not cover the following types: ContactPoint.\nThe mappings for `HealthcareService.telecom` do not cover the following types based on type expansion: period, rank, system, use, value.\nIf this is empty, then refer to the location's contacts.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.telecom|0.1.0"
}
]
},
{
"id": "HealthcareService.coverageArea.extension",
"path": "HealthcareService.coverageArea.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "HealthcareService.coverageArea.extension:coverageArea",
"path": "HealthcareService.coverageArea.extension",
"sliceName": "coverageArea",
"short": "R4B: Location(s) service is intended for/available to additional types",
"definition": "R4B: `HealthcareService.coverageArea` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `HealthcareService.coverageArea` is mapped to FHIR STU3 element `HealthcareService.coverageArea` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.coverageArea` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `HealthcareService.coverageArea` with unmapped reference targets: Location.\nThe 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": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "HealthcareService.notAvailable.during.extension",
"path": "HealthcareService.notAvailable.during.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "HealthcareService.notAvailable.during.extension:during",
"path": "HealthcareService.notAvailable.during.extension",
"sliceName": "during",
"short": "R4B: Service not available from this date additional types",
"definition": "R4B: `HealthcareService.notAvailable.during` additional types (Period) additional types from child elements (end, start)",
"comment": "Element `HealthcareService.notAvailable.during` is mapped to FHIR STU3 element `HealthcareService.notAvailable.during` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.notAvailable.during` do not cover the following types: Period.\nThe mappings for `HealthcareService.notAvailable.during` do not cover the following types based on type expansion: end, start.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-HealthcareService.notAvailable.during|0.1.0"
}
]
},
{
"id": "HealthcareService.endpoint.extension",
"path": "HealthcareService.endpoint.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "HealthcareService.endpoint.extension:endpoint",
"path": "HealthcareService.endpoint.extension",
"sliceName": "endpoint",
"short": "R4B: Technical endpoints providing access to electronic services operated for the healthcare service additional types",
"definition": "R4B: `HealthcareService.endpoint` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `HealthcareService.endpoint` is mapped to FHIR STU3 element `HealthcareService.endpoint` as `SourceIsBroaderThanTarget`.\nThe mappings for `HealthcareService.endpoint` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `HealthcareService.endpoint` with unmapped reference targets: Endpoint.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
}
]
}
}