{
"description": "The HSD HealthcareService profile was introduced in STU 1 of this guide to allow example value sets that are used to search human and social service directories, because based on guidance from the human and social services community, existing human and social services taxonomies have not been deemed suitable for use in the relevant value sets. This profile isbased on the R4 HealthcareService resource, and fully aligned (as opposed to derived from) the Plan-Net HealthcareService profile which enforces use of extensible bindings to the category and type elements. This profile describes the way a human/social service can be contacted to assist patients and clients with unmet social needs. Examples include food, housing/shelter, income & employment, public transportation, public education, legal services, disability and aging and mental and physical health.",
"_filename": "StructureDefinition-hsds-HealthcareService.json",
"package_name": "hl7.fhir.us.hsds",
"date": "2023-10-04T18:51:43+00:00",
"derivation": "constraint",
"publisher": "HL7 Human and Social Services Work Group",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "HSDHealthcareService",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "HSDS",
"name": "HSDS",
"comment": "This section describes the way HSDS version 2.0.1 elements are mapped from HSDS tables to the FHIR HSDHealthcareService profile. The left hand column contains the FHIR HSDHealthcareService element name; the right hand column contains the HSDS table.element and any implementation/transformation rules required to support the mapping.\n\nThe HSDS specification (v.2.0.1) served as the initial basis for requirements, and the mapping/alignment of HSDS data elements to profiles contained in the FHIR IG for Human Service Directories, STU1. HSDS Version 2.0.1 applies string datatypes to nearly all HSDS table 'id' fields/ data elements, including the id field associated with each HSDS [table] (e.g. organization.id [organization], location.id [location], service.id [service], phone.id [phone], etc.)). In the next version of HSDS, v.3.0, each HSDS table.id field will be defined using the UUID data type.\n\nFHIR Resource .ids (and the .ids in their profiles) are defined using the FHIR id datatype, a string that supports \"Any combination of upper- or lower-case ASCII letters ('A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.', with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)\". \n\nBecause UUIDs provide uniqueness to data/resources when they are exchanged across multiple systems, it is recommended that implementers of the FHIR IG for Human Services Directories support UUIDs in all HSDS id fields that are mapped to FHIR .id data elements.",
"identity": "hsds"
} ],
"abstract": false,
"type": "HealthcareService",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "HSDHealthcareService",
"package_version": "1.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "hss"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2,
"_valueInteger": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/us/hsds/ImplementationGuide/hl7.fhir.us.hsds"
} ]
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/us/hsds/ImplementationGuide/hl7.fhir.us.hsds"
} ]
}
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"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",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "HealthcareService",
"min": 0,
"definition": "The details of a healthcare service available at a location.",
"isModifier": false,
"short": "The details of a healthcare service available at a location",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "act[classCode=ACT][moodCode=DEF]",
"identity": "rim"
} ],
"max": "*",
"id": "HealthcareService",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService"
},
"isSummary": false
}, {
"path": "HealthcareService.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"mapping": [ {
"map": "service.id Note: Each service must have a unique identifier.",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"max": "1",
"id": "HealthcareService.id",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"mapping": [ {
"map": "metadata Note: The HSDS metadata table contains a record of the changes that have been made to the data in order to maintain provenance information.",
"identity": "hsds"
} ],
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "HealthcareService.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "HealthcareService.meta.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HealthcareService.meta.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.meta.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.meta.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.meta.versionId",
"min": 0,
"definition": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.",
"isModifier": false,
"short": "Version specific identifier",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "HealthcareService.meta.versionId",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.versionId"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.meta.lastUpdated",
"min": 1,
"definition": "When the resource last changed - e.g. when the version changed.",
"isModifier": false,
"short": "When the resource version last changed",
"mapping": [ {
"map": "metadata.last_action_date Note: The date when data was changed. Since there may be more than one metadata record for each location, the latest max(last_action_date) needs to be used from metadata where service.id = metadata.resource_id.",
"identity": "hsds"
} ],
"type": [ {
"code": "instant"
} ],
"max": "1",
"id": "HealthcareService.meta.lastUpdated",
"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. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.lastUpdated"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.meta.source",
"min": 0,
"definition": "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.",
"isModifier": false,
"short": "Identifies where the resource comes from",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "HealthcareService.meta.source",
"comment": "In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.source"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.meta.profile",
"min": 0,
"definition": "A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).",
"isModifier": false,
"short": "Profiles this resource claims to conform to",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"max": "*",
"id": "HealthcareService.meta.profile",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.profile"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.meta.security",
"min": 0,
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"isModifier": false,
"short": "Security Labels applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/security-labels",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System."
},
"max": "*",
"id": "HealthcareService.meta.security",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.security"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.meta.tag",
"min": 0,
"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.",
"isModifier": false,
"short": "Tags applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/common-tags",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
} ],
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"."
},
"max": "*",
"id": "HealthcareService.meta.tag",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.tag"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "HealthcareService.implicitRules",
"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "HealthcareService.language",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "HealthcareService.text",
"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 information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "HealthcareService.contained",
"min": 0,
"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.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "HealthcareService.contained",
"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "HealthcareService.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
}, {
"key": "new-patients-characteristics",
"human": "If no new patients are accepted, no characteristics are allowed",
"source": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients",
"severity": "error",
"expression": "extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()"
} ],
"path": "HealthcareService.extension",
"min": 0,
"definition": "New Patients indicates whether new patients are being accepted in general, or from a specific network. \n This extension is included in the PractitionerRole, HealthcareService, and Location profiles. \n This provides needed flexibility for specifying whether a provider accepts new patients by location and network.",
"isModifier": false,
"short": "New Patients",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. This extension indicates whether new patients are being accepted in general, or from a specific network.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients" ]
} ],
"sliceName": "newpatients",
"max": "0",
"id": "HealthcareService.extension:newpatients",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.extension",
"min": 0,
"definition": "An extension describing the service delivery method. If service delivery is virtual, one or more delivery modalities should be specified.",
"isModifier": false,
"short": "Delivery Method",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. While this is a Must Support element in the parent Plan-Net profile, it is optional and therefore, will be ignored.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method" ]
} ],
"sliceName": "deliverymethod",
"max": "0",
"id": "HealthcareService.extension:deliverymethod",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.identifier",
"min": 0,
"definition": "External identifiers for this item.",
"isModifier": false,
"short": "External identifiers for this item",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with services in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "HealthcareService.identifier",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.identifier"
},
"isSummary": true
}, {
"path": "HealthcareService.identifier.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with services in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HealthcareService.identifier.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.identifier.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.identifier.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary | old (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known ."
},
"max": "1",
"id": "HealthcareService.identifier.use",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"isModifier": false,
"short": "Description of identifier",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
}, {
"map": "No Source. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
},
"max": "1",
"id": "HealthcareService.identifier.type",
"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. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.identifier.system",
"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,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"isModifier": false,
"short": "The namespace for the identifier value",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "HealthcareService.identifier.system",
"comment": "Identifier.system is always case sensitive.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.identifier.value",
"min": 0,
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"isModifier": false,
"short": "The value that is unique",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
}, {
"map": "No Source. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "HealthcareService.identifier.value",
"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/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"isModifier": false,
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "HealthcareService.identifier.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.identifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"isModifier": false,
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "HealthcareService.identifier.assigner",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.active",
"min": 1,
"definition": "This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.",
"isModifier": true,
"short": "Whether this HealthcareService record is in active use",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": ".statusCode",
"identity": "rim"
}, {
"map": "If HSDS service.status = 'active' then FHIR HealthcareService.active = 'true', else HealthcareService.active = 'false'. \nNote: HSDS service.status values are 'active', 'inactive', 'defunct' and 'temporarily closed'. All types other than 'active' are considered 'inactive' as per FHIR status.",
"identity": "hsds"
} ],
"type": [ {
"code": "boolean"
} ],
"patternBoolean": true,
"mustSupport": true,
"meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element",
"max": "1",
"id": "HealthcareService.active",
"comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.active"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.providedBy",
"min": 1,
"definition": "The organization that provides this healthcare service.",
"isModifier": false,
"short": "Organization that provides this service",
"mapping": [ {
"map": ".scopingRole.Organization",
"identity": "rim"
}, {
"map": "reference.reference = service.organization_id \nreference.type = 'Organization' \nreference.display = organization.name\nNote: This element is of data type Reference that refers to the organization resource that provides this service.",
"identity": "hsds"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Organization" ]
} ],
"mustSupport": true,
"max": "1",
"id": "HealthcareService.providedBy",
"comment": "This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.providedBy"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.category",
"min": 1,
"definition": "Identifies the broad category of service being performed or delivered.",
"isModifier": false,
"short": "This is an example value set. In addition to the Plan-Net codes defined in this IG, concepts drawn from the 211 LA or Open Eligibility taxonomies as well as the FHIR SDOHCC ValueSet SDOH Category could be used until the social care community recommends an appropriate standard.",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "category.coding.system = 'http://211hsis.org'\ncategory.coding.code = taxonomy_term.term\ncateory.coding.display = taxonomy_term.description\ncategory.text = taxonomy_term.description\nNote: This mapping is to the service category level taxonomy term that will be a parent to service type level taxonomy term. Linkage to category level term is from service.id = service_attribute_id, service_attribute.taxonomy_term_id = taxonomy_term.id, (child) taxonomy_term.parent.id = (parent) taxonomy_term.id. This assumes a two-level hierarchy of taxonomy terms. If there are more levels of hierarchy, then this will require traversing through the hierarchy until category level taxonomy_term parent is reached. Service Category binding will be to specific concepts from 211 Human Services Indexing System.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/hsds/ValueSet/HumanServiceCategory"
},
"alias": [ "service category" ],
"max": "1",
"id": "HealthcareService.category",
"comment": "Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.category"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.type",
"min": 0,
"definition": "The specific type of service that may be delivered or performed.",
"isModifier": false,
"short": "This is an example value set. In addition to the Plan-Net codes defined in this IG, concepts drawn from either the 211 LA or Open Eligibility taxonomies could be used until the social care community recommends an appropriate standard.",
"mapping": [ {
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code",
"identity": "rim"
}, {
"map": "category.coding.system = 'http://211hsis.org'\ncategory.coding.code = taxonomy_term.term\ncateory.coding.display = taxonomy_term.description\ncategory.text = taxonomy_term.description\nNote: This mapping is to the service type level taxonomy term that will be directly linked to the service attribute. Linkage to service type term is from service.id = service_attribute_id, service_attribute.taxonomy_term_id = taxonomy_term.id/. Service Type binding will be to specific concepts from 211 Human Services Indexing System.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/hsds/ValueSet/HumanServiceType"
},
"alias": [ "service type" ],
"max": "*",
"id": "HealthcareService.type",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.specialty",
"min": 0,
"definition": "Collection of specialties handled by the service site. This is more of a medical term.",
"isModifier": false,
"short": "Specialties handled by the HealthcareService",
"mapping": [ {
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code",
"identity": "rim"
}, {
"map": "No Source. \nNote: This is a GAP in HSDS. specialty is defined as Must Support in the Plan-Net profile but optional element. The Plan-Net profile defines as required binding to valueset that refers to the standardized NUCC taxonomy https://taxonomy.nucc.org/. However, this taxonomy does not contain most of the human services specific provider types (except 332U00000X: Home Delivered Meals). This mapping will be ignored for the time being until NUCC is extended to include human service providers and HSDS is modified to include the specialty of providers who can provide this service.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/us/hsds/ValueSet/NonIndividualSpecialties"
},
"max": "*",
"id": "HealthcareService.specialty",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.specialty"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.location",
"min": 0,
"definition": "The location(s) where this healthcare service may be provided.",
"isModifier": false,
"short": "Location(s) where service may be provided",
"mapping": [ {
"map": "FiveWs.where[x]",
"identity": "w5"
}, {
"map": ".location.role[classCode=SDLOC]",
"identity": "rim"
}, {
"map": "reference.reference = service_at_location.location_id\nreference.type = 'Location' \nreference.display = location.name\nNote: This element is of data type Reference that refers to the location resource where a given service can be provided. Linkage to location is service.id = service_at_location.service_id, service_at_location.location_id = location.id. There may be multiple locations for a given service. Since FHIR location is an array (list), each location will be populated in an individual position in the array.",
"identity": "hsds"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Location" ]
} ],
"mustSupport": true,
"max": "*",
"id": "HealthcareService.location",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.location"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.name",
"min": 0,
"definition": "Further description of the service as it would be presented to a consumer while searching.",
"isModifier": false,
"short": "Description of service as presented to a consumer while searching",
"mapping": [ {
"map": ".name",
"identity": "rim"
}, {
"map": "service.name",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "HealthcareService.name",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.comment",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional description and/or any specific issues not covered elsewhere",
"mapping": [ {
"map": ".location.role[classCode=SDLOC].desc",
"identity": "rim"
}, {
"map": "No Source. Note: This is a GAP in HSDS. There is no comment or description for a service. There is a description in service_at_location but that will not be just specific to service but the combination of service and location.",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.comment",
"comment": "Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.comment"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.extraDetails",
"min": 0,
"definition": "Extra details about the service that can't be placed in the other fields.",
"isModifier": false,
"short": "Extra details about the service that can't be placed in the other fields",
"mapping": [ {
"map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text",
"identity": "rim"
}, {
"map": "Fixed value 'Funding Source:' appended with funding.source Note: Ths data element name extraDetails is not obvious about its content and this mapping to the funding source is not a direct mapping. Therefore it is advised to map this as a name-value pair, i.e., add a label before the value e.g., 'Funding Source '. Linkage to the funding source is service.organiztion_id = funding.organization_id and service.id = funding.service_id. If there are multiple funding sources for this combiation, they are concatenated.",
"identity": "hsds"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "HealthcareService.extraDetails",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.extraDetails"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.photo",
"min": 0,
"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.",
"isModifier": false,
"short": "Facilitates quick identification of the service",
"mapping": [ {
"map": ".actrelationship[typeCode=SBJ].observation.value",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "Attachment"
} ],
"max": "1",
"id": "HealthcareService.photo",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.photo"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.telecom",
"min": 0,
"definition": "List of contacts related to this specific healthcare service.",
"isModifier": false,
"short": "Contacts related to the healthcare service",
"mapping": [ {
"map": ".telecom",
"identity": "rim"
}, {
"map": "Note: This FHIR structure contains contact details of the service using the ContactPoint datatype (Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc.).",
"identity": "hsds"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "*",
"id": "HealthcareService.telecom",
"comment": "If this is empty, then refer to the location's contacts.",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.telecom"
},
"isSummary": false
}, {
"path": "HealthcareService.telecom.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This data element may be ignored as having the id for the telecom record isn't essential and not always available in the HSDS (e.g. phone id is available but there is no separate id for email or website URL).",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HealthcareService.telecom.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.telecom.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.telecom.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.telecom.extension",
"min": 0,
"definition": "An extension representing the days and times a contact point is available",
"isModifier": false,
"short": "Contactpoint Availabletime",
"mapping": [ {
"map": "No Source.\nNote: This is a GAP in HSDS. This FHIR extension is added by the Plan-Net profile and represents available hours for the telecom (e.g. customer service phone hours from 8AM-6PM M-F). There is no equivalent mapping to this data element in HSDS since the HSDS schedule table contains details of when a service or location is open and is not related to a phone line associated with a location.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime" ]
} ],
"sliceName": "contactpoint-availabletime",
"max": "0",
"id": "HealthcareService.telecom.extension:contactpoint-availabletime",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.telecom.extension",
"min": 0,
"definition": "A reference to an alternative point of contact (plannet-PractitionerRole, plannet-Organization, plannet-OrganizationAffiliation, or plannet-Location) for this organization",
"isModifier": false,
"short": "Via Intermediary",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. This FHIR extension added by the Plan-Net profile represents a reference to an alternative point of contact. HSDS does not have the source data to represent an 'intermediary' as that implies some sort of location relationship.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary" ]
} ],
"sliceName": "via-intermediary",
"max": "0",
"id": "HealthcareService.telecom.extension:via-intermediary",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.telecom.extension",
"min": 0,
"definition": "An extension to describe the additional details for named contacts for services not included in the telecom element.",
"isModifier": false,
"short": "Additional contact information for services",
"mapping": [ {
"map": "This is a GAP in FHIR. Created a new extension: service-contactinfo to map HSDS contact.name, contact.title, contact.department, and contact.email",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/hsds/StructureDefinition/service-contactinfo" ]
} ],
"sliceName": "service-contactinfo",
"max": "*",
"id": "HealthcareService.telecom.extension:service-contactinfo",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.telecom.system",
"min": 0,
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"isModifier": false,
"short": "phone | fax | email | pager | url | sms | other",
"mapping": [ {
"map": "XTN.3",
"identity": "v2"
}, {
"map": "./scheme",
"identity": "rim"
}, {
"map": "./ContactPointType",
"identity": "servd"
}, {
"map": "For Phone: \n if phone.type = 'voice' then system = 'phone' \n if phone.type = 'cell' then system = 'phone' \n if phone.type = 'fax' then system = 'fax' \n if phone.type = 'pager' then system = 'pager' \n if phone.type = 'text' then system = 'sms' \n if phone.type = 'textphone' then system = 'sms' \n if phone.type = 'video' then system = 'other' \nFor Email:\n Fixed value = 'email' \nFor Website URL:\n Fixed value = 'url' \nNote: There are multiple sources in HSDS for the telecom in FHIR so the system will be populated based on phone.type mapping or fixed value of 'email' or 'url' depending on the data populated. Drawn from the ContactPointSystem value set [http://hl7.org/fhir/ValueSet/contact-point-system]",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointSystem"
} ],
"description": "Telecommunications form for contact point."
},
"max": "1",
"id": "HealthcareService.telecom.system",
"condition": [ "cpt-2" ],
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.telecom.value",
"requirements": "Need to support legacy numbers that are not in a tightly controlled format.",
"min": 0,
"definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"isModifier": false,
"short": "The actual contact point details",
"mapping": [ {
"map": "XTN.1 (or XTN.12)",
"identity": "v2"
}, {
"map": "./url",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
}, {
"map": "For Phone: \n value = phone.number \nFor Email,\n value = service.email\nFor Website URL: \n value = service.url\nNote: For phone, HSDS service linkage is to phone table using service.id = phone.service_id.",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.telecom.value",
"comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.telecom.use",
"fixedCode": "work",
"requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min": 0,
"definition": "Identifies the purpose for the contact point.",
"isModifier": true,
"short": "home | work | temp | old | mobile - purpose of this contact point",
"mapping": [ {
"map": "XTN.2 - but often indicated by field",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./ContactPointPurpose",
"identity": "servd"
}, {
"map": "Fixed value = 'work' Note: This is a GAP in HSDS but since it is for work-related information, it is possible to set this to 'work' drawn from the ContactPointUse value set http://hl7.org/fhir/R4/valueset-contact-point-use.html.",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointUse"
} ],
"description": "Use of contact point."
},
"max": "1",
"id": "HealthcareService.telecom.use",
"comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.telecom.rank",
"min": 0,
"definition": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.",
"isModifier": false,
"short": "Specify preferred order of use (1 = highest)",
"mapping": [ {
"map": "n/a",
"identity": "v2"
}, {
"map": "n/a",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, it is used to specify a preferred order in which to use a contact point. The parent Plan-Net profile indicates this is a Must Support element but is optional, So it can be excluded since there is no source.",
"identity": "hsds"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "HealthcareService.telecom.rank",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.rank"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.telecom.period",
"min": 0,
"definition": "Time period when the contact point was/is in use.",
"isModifier": false,
"short": "Time period when the contact point was/is in use",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, this data element captures the time period when the contact point was/is in use. But it can be excluded since there is no source and it is optional.",
"identity": "hsds"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "HealthcareService.telecom.period",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.coverageArea",
"min": 0,
"definition": "The location(s) that this service is available to (not where the service is provided).",
"isModifier": false,
"short": "Location(s) service is intended for/available to",
"mapping": [ {
"map": ".location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate",
"identity": "rim"
}, {
"map": "reference.display = service_area.service_area Note: FHIR HealthcareService.coverageArea is a reference of location resource so service_area cannot be directly used. Although generally not recommended, this is mapped to Reference.display since there is no other corresponding data element in FHIR to HSDS service area. If there are multiple service_area records for a given service, they are concatenated to make a single string.",
"identity": "hsds"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Location" ]
} ],
"max": "*",
"id": "HealthcareService.coverageArea",
"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\".",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.coverageArea"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.serviceProvisionCode",
"min": 0,
"definition": "The code(s) that detail the conditions under which the healthcare service is available/offered.",
"isModifier": false,
"short": "Conditions under which service is available/offered",
"mapping": [ {
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. That element is the code describing healthcare service provision conditions such as 'free', 'disc' or 'cost'.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/service-provision-conditions",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceProvisionConditions"
} ],
"description": "The code(s) that detail the conditions under which the healthcare service is available/offered."
},
"max": "*",
"id": "HealthcareService.serviceProvisionCode",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.serviceProvisionCode"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.eligibility",
"min": 0,
"definition": "Does this service have specific eligibility requirements that need to be met in order to use the service?",
"isModifier": false,
"short": "Specific eligibility requirements required to use the service",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. Eligibility is currently out of scope for this release of the IG as Eligibility is not addressed by the HSDS eligibility specification (insufficient details to capture eligibility details as only a primary key (eligibility.id) and eligibility.service_id are included in the table.)",
"identity": "hsds"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "HealthcareService.eligibility",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.eligibility"
},
"isSummary": false
}, {
"path": "HealthcareService.eligibility.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping.",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HealthcareService.eligibility.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.eligibility.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.eligibility.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.eligibility.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "HealthcareService.eligibility.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.eligibility.code",
"min": 0,
"definition": "Coded value for the eligibility.",
"isModifier": false,
"short": "Coded value for the eligibility",
"mapping": [ {
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ServiceEligibility"
} ],
"description": "Coded values underwhich a specific service is made available."
},
"max": "1",
"id": "HealthcareService.eligibility.code",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.eligibility.code"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.eligibility.comment",
"min": 0,
"definition": "Describes the eligibility conditions for the service.",
"isModifier": false,
"short": "Describes the eligibility conditions for the service",
"mapping": [ {
"map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping.",
"identity": "hsds"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "HealthcareService.eligibility.comment",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.eligibility.comment"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.program",
"min": 0,
"definition": "Programs that this service is applicable to.",
"isModifier": false,
"short": "This example value set includes codes that describe Programs under which community-based organizations can organize the social services they deliver.",
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
}, {
"map": "program[0].text = program.name Note: Since HSDS does not have any code for the program, only the text element of codeableConcept is mapped. Also, the program data element in FHIR is an array (list), so the program name from HSDS is populated in the first occurrence of the array.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/hsds/ValueSet/HumanServiceProgram"
},
"max": "*",
"id": "HealthcareService.program",
"comment": "Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.program"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.characteristic",
"min": 0,
"definition": "Collection of characteristics (attributes).",
"isModifier": false,
"short": "This example value set includes codes that describe unique features that can be associated with community-based social services delivered at particular locations.",
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
}, {
"map": "characteristic[0].text = service.interpretation_services \nNote: This is not an obvious mapping but interpretation services is one of the characteristics of the service provision. Also, this data element in FHIR is an array (list), so the interpretation services data from HSDS is populated in the first occurrence of the array.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/hsds/ValueSet/HumanServiceCharacteristic"
},
"max": "*",
"id": "HealthcareService.characteristic",
"comment": "These could be such things as is wheelchair accessible.",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.characteristic"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.communication",
"min": 0,
"definition": "Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.",
"isModifier": false,
"short": "The language that this service is offered in",
"mapping": [ {
"map": "communication[0].text = language.language. Note: This data element in FHIR is an array (list), so the language from HSDS is populated in the first occurrence of the array.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "*",
"id": "HealthcareService.communication",
"comment": "When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling.",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.communication"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.referralMethod",
"min": 0,
"definition": "Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.",
"isModifier": false,
"short": "Ways that the service accepts referrals",
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/service-referral-method",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferralMethod"
} ],
"description": "The methods of referral can be used when referring to a specific HealthCareService resource."
},
"max": "*",
"id": "HealthcareService.referralMethod",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.referralMethod"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.appointmentRequired",
"min": 0,
"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.",
"isModifier": false,
"short": "If an appointment is required for access to this service",
"mapping": [ {
"map": ".actrelationship[typeCode=PERT].observation",
"identity": "rim"
}, {
"map": "No Source. Note: This is a GAP in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "HealthcareService.appointmentRequired",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.appointmentRequired"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.availableTime",
"min": 0,
"definition": "A collection of times that the Service Site is available.",
"isModifier": false,
"short": "Times the Service Site is available",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "Note: This structure identifies the days/times during a week this service may be provided. Linkage to the schedule is from service.id = schedule.service_id.",
"identity": "hsds"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "HealthcareService.availableTime",
"comment": "More detailed availability information may be provided in associated Schedule/Slot resources.",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.availableTime"
},
"isSummary": false
}, {
"path": "HealthcareService.availableTime.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "schedule.id Note: This data element may be ignored as having the id for the schedule record isn't essential.",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HealthcareService.availableTime.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.availableTime.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"mapping": [ {
"map": "extension[0].valueSting = schedule.description Note: This is not an obvious mapping but the extension is available to provide additional details. Since the extension is an array (list), the description will be populated in the first occurrence of the extension.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "HealthcareService.availableTime.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.availableTime.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "HealthcareService.availableTime.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.availableTime.daysOfWeek",
"min": 0,
"definition": "Indicates which days of the week are available between the start and end Times.",
"isModifier": false,
"short": "mon | tue | wed | thu | fri | sat | sun",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "schedule.byday Note: This is a comma-separated value of days of the week. e.g. SU,MO,TU,WE,TH,FR,SA. Where freq is MONTHLY each part can be preceded by a positive or negative integer to represent which occurrence in a month; e.g. 2MO is the second Monday in a month. -1FR is last Friday.",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DaysOfWeek"
} ],
"description": "The days of the week."
},
"max": "*",
"id": "HealthcareService.availableTime.daysOfWeek",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.availableTime.daysOfWeek"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.availableTime.allDay",
"min": 0,
"definition": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.",
"isModifier": false,
"short": "Always available? e.g. 24 hour service",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "No Source. Note: This is a GAP in HSDS. May be derived from other HSDS data elements but may not be an accurate representation.",
"identity": "hsds"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "HealthcareService.availableTime.allDay",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.availableTime.allDay"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.availableTime.availableStartTime",
"min": 0,
"definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.",
"isModifier": false,
"short": "Opening time of day (ignored if allDay = true)",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "schedule.opens_at Note: This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.)",
"identity": "hsds"
} ],
"type": [ {
"code": "time"
} ],
"max": "1",
"id": "HealthcareService.availableTime.availableStartTime",
"comment": "The time zone is expected to be for where this HealthcareService is provided at.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.availableTime.availableStartTime"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.availableTime.availableEndTime",
"min": 0,
"definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.",
"isModifier": false,
"short": "Closing time of day (ignored if allDay = true)",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "schedule.closes_at Note: This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.)",
"identity": "hsds"
} ],
"type": [ {
"code": "time"
} ],
"max": "1",
"id": "HealthcareService.availableTime.availableEndTime",
"comment": "The time zone is expected to be for where this HealthcareService is provided at.",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.availableTime.availableEndTime"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.notAvailable",
"min": 0,
"definition": "The HealthcareService is not available during this period of time due to the provided reason.",
"isModifier": false,
"short": "Not available during this time due to provided reason",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "No Source. Note: This is a GAP in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "HealthcareService.notAvailable",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.notAvailable"
},
"isSummary": false
}, {
"path": "HealthcareService.notAvailable.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "HealthcareService.notAvailable.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.notAvailable.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "HealthcareService.notAvailable.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "HealthcareService.notAvailable.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "HealthcareService.notAvailable.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.notAvailable.description",
"min": 1,
"definition": "The reason that can be presented to the user as to why this time is not available.",
"isModifier": false,
"short": "Reason presented to the user explaining why time not available",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.notAvailable.description",
"base": {
"max": "1",
"min": 1,
"path": "HealthcareService.notAvailable.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.notAvailable.during",
"min": 0,
"definition": "Service is not available (seasonally or for a public holiday) from this date.",
"isModifier": false,
"short": "Service not available from this date",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "HealthcareService.notAvailable.during",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.notAvailable.during"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.availabilityExceptions",
"min": 0,
"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.",
"isModifier": false,
"short": "Description of availability exceptions",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "No Source. Note: This is a GAP in HSDS. This is a Must Support but an optional element in the base Plan-Net profile.",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "HealthcareService.availabilityExceptions",
"base": {
"max": "1",
"min": 0,
"path": "HealthcareService.availabilityExceptions"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "HealthcareService.endpoint",
"min": 0,
"definition": "Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.",
"isModifier": false,
"short": "Technical endpoints providing access to electronic services operated for the healthcare service",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "No Source. Note: This is for the technical implementation of web services for the healthcare service and it is not for source-specific business data. It is marked as Must Support though optional in the Plan-Net profile. At this point, no service- specific web services have been identified so it may be ignored.",
"identity": "hsds"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ]
} ],
"max": "*",
"id": "HealthcareService.endpoint",
"base": {
"max": "*",
"min": 0,
"path": "HealthcareService.endpoint"
},
"isSummary": false
} ]
},
"status": "active",
"id": "92fe08a9-7a8c-42be-a836-2fe21bf5b2fb",
"kind": "resource",
"url": "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-HealthcareService",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "HealthcareService",
"path": "HealthcareService"
}, {
"id": "HealthcareService.id",
"path": "HealthcareService.id",
"mapping": [ {
"map": "service.id Note: Each service must have a unique identifier.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.meta",
"path": "HealthcareService.meta",
"mapping": [ {
"map": "metadata Note: The HSDS metadata table contains a record of the changes that have been made to the data in order to maintain provenance information.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.meta.lastUpdated",
"min": 1,
"path": "HealthcareService.meta.lastUpdated",
"mapping": [ {
"map": "metadata.last_action_date Note: The date when data was changed. Since there may be more than one metadata record for each location, the latest max(last_action_date) needs to be used from metadata where service.id = metadata.resource_id.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.extension",
"path": "HealthcareService.extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "HealthcareService.extension:newpatients",
"max": "0",
"min": 0,
"path": "HealthcareService.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients" ]
} ],
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. This extension indicates whether new patients are being accepted in general, or from a specific network.",
"identity": "hsds"
} ],
"sliceName": "newpatients"
}, {
"id": "HealthcareService.extension:deliverymethod",
"max": "0",
"min": 0,
"path": "HealthcareService.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method" ]
} ],
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. While this is a Must Support element in the parent Plan-Net profile, it is optional and therefore, will be ignored.",
"identity": "hsds"
} ],
"sliceName": "deliverymethod"
}, {
"id": "HealthcareService.identifier",
"path": "HealthcareService.identifier",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with services in HSDS.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.identifier.id",
"path": "HealthcareService.identifier.id",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with services in HSDS.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.identifier.use",
"path": "HealthcareService.identifier.use",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.identifier.type",
"path": "HealthcareService.identifier.type",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ],
"mustSupport": true
}, {
"id": "HealthcareService.identifier.system",
"path": "HealthcareService.identifier.system",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.identifier.value",
"path": "HealthcareService.identifier.value",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ],
"mustSupport": true
}, {
"id": "HealthcareService.identifier.period",
"path": "HealthcareService.identifier.period",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.identifier.assigner",
"path": "HealthcareService.identifier.assigner",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. There are no business identifiers associated with locations in HSDS.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.active",
"min": 1,
"path": "HealthcareService.active",
"mapping": [ {
"map": "If HSDS service.status = 'active' then FHIR HealthcareService.active = 'true', else HealthcareService.active = 'false'. \nNote: HSDS service.status values are 'active', 'inactive', 'defunct' and 'temporarily closed'. All types other than 'active' are considered 'inactive' as per FHIR status.",
"identity": "hsds"
} ],
"mustSupport": true,
"patternBoolean": true
}, {
"id": "HealthcareService.providedBy",
"min": 1,
"path": "HealthcareService.providedBy",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Organization" ]
} ],
"mapping": [ {
"map": "reference.reference = service.organization_id \nreference.type = 'Organization' \nreference.display = organization.name\nNote: This element is of data type Reference that refers to the organization resource that provides this service.",
"identity": "hsds"
} ],
"mustSupport": true
}, {
"id": "HealthcareService.category",
"max": "1",
"min": 1,
"path": "HealthcareService.category",
"short": "This is an example value set. In addition to the Plan-Net codes defined in this IG, concepts drawn from the 211 LA or Open Eligibility taxonomies as well as the FHIR SDOHCC ValueSet SDOH Category could be used until the social care community recommends an appropriate standard.",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/hsds/ValueSet/HumanServiceCategory"
},
"mapping": [ {
"map": "category.coding.system = 'http://211hsis.org'\ncategory.coding.code = taxonomy_term.term\ncateory.coding.display = taxonomy_term.description\ncategory.text = taxonomy_term.description\nNote: This mapping is to the service category level taxonomy term that will be a parent to service type level taxonomy term. Linkage to category level term is from service.id = service_attribute_id, service_attribute.taxonomy_term_id = taxonomy_term.id, (child) taxonomy_term.parent.id = (parent) taxonomy_term.id. This assumes a two-level hierarchy of taxonomy terms. If there are more levels of hierarchy, then this will require traversing through the hierarchy until category level taxonomy_term parent is reached. Service Category binding will be to specific concepts from 211 Human Services Indexing System.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.type",
"path": "HealthcareService.type",
"short": "This is an example value set. In addition to the Plan-Net codes defined in this IG, concepts drawn from either the 211 LA or Open Eligibility taxonomies could be used until the social care community recommends an appropriate standard.",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/hsds/ValueSet/HumanServiceType"
},
"mapping": [ {
"map": "category.coding.system = 'http://211hsis.org'\ncategory.coding.code = taxonomy_term.term\ncateory.coding.display = taxonomy_term.description\ncategory.text = taxonomy_term.description\nNote: This mapping is to the service type level taxonomy term that will be directly linked to the service attribute. Linkage to service type term is from service.id = service_attribute_id, service_attribute.taxonomy_term_id = taxonomy_term.id/. Service Type binding will be to specific concepts from 211 Human Services Indexing System.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.specialty",
"path": "HealthcareService.specialty",
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/us/hsds/ValueSet/NonIndividualSpecialties"
},
"mapping": [ {
"map": "No Source. \nNote: This is a GAP in HSDS. specialty is defined as Must Support in the Plan-Net profile but optional element. The Plan-Net profile defines as required binding to valueset that refers to the standardized NUCC taxonomy https://taxonomy.nucc.org/. However, this taxonomy does not contain most of the human services specific provider types (except 332U00000X: Home Delivered Meals). This mapping will be ignored for the time being until NUCC is extended to include human service providers and HSDS is modified to include the specialty of providers who can provide this service.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.location",
"path": "HealthcareService.location",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Location" ]
} ],
"mapping": [ {
"map": "reference.reference = service_at_location.location_id\nreference.type = 'Location' \nreference.display = location.name\nNote: This element is of data type Reference that refers to the location resource where a given service can be provided. Linkage to location is service.id = service_at_location.service_id, service_at_location.location_id = location.id. There may be multiple locations for a given service. Since FHIR location is an array (list), each location will be populated in an individual position in the array.",
"identity": "hsds"
} ],
"mustSupport": true
}, {
"id": "HealthcareService.name",
"path": "HealthcareService.name",
"mapping": [ {
"map": "service.name",
"identity": "hsds"
} ],
"mustSupport": true
}, {
"id": "HealthcareService.comment",
"path": "HealthcareService.comment",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. There is no comment or description for a service. There is a description in service_at_location but that will not be just specific to service but the combination of service and location.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.extraDetails",
"path": "HealthcareService.extraDetails",
"mapping": [ {
"map": "Fixed value 'Funding Source:' appended with funding.source Note: Ths data element name extraDetails is not obvious about its content and this mapping to the funding source is not a direct mapping. Therefore it is advised to map this as a name-value pair, i.e., add a label before the value e.g., 'Funding Source '. Linkage to the funding source is service.organiztion_id = funding.organization_id and service.id = funding.service_id. If there are multiple funding sources for this combiation, they are concatenated.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.photo",
"path": "HealthcareService.photo",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.telecom",
"path": "HealthcareService.telecom",
"mapping": [ {
"map": "Note: This FHIR structure contains contact details of the service using the ContactPoint datatype (Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc.).",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.telecom.id",
"path": "HealthcareService.telecom.id",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This data element may be ignored as having the id for the telecom record isn't essential and not always available in the HSDS (e.g. phone id is available but there is no separate id for email or website URL).",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.telecom.extension:contactpoint-availabletime",
"max": "0",
"min": 0,
"path": "HealthcareService.telecom.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime" ]
} ],
"mapping": [ {
"map": "No Source.\nNote: This is a GAP in HSDS. This FHIR extension is added by the Plan-Net profile and represents available hours for the telecom (e.g. customer service phone hours from 8AM-6PM M-F). There is no equivalent mapping to this data element in HSDS since the HSDS schedule table contains details of when a service or location is open and is not related to a phone line associated with a location.",
"identity": "hsds"
} ],
"sliceName": "contactpoint-availabletime"
}, {
"id": "HealthcareService.telecom.extension:via-intermediary",
"max": "0",
"min": 0,
"path": "HealthcareService.telecom.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary" ]
} ],
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. This FHIR extension added by the Plan-Net profile represents a reference to an alternative point of contact. HSDS does not have the source data to represent an 'intermediary' as that implies some sort of location relationship.",
"identity": "hsds"
} ],
"sliceName": "via-intermediary"
}, {
"id": "HealthcareService.telecom.extension:service-contactinfo",
"max": "*",
"min": 0,
"path": "HealthcareService.telecom.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/hsds/StructureDefinition/service-contactinfo" ]
} ],
"short": "Additional contact information for services",
"mapping": [ {
"map": "This is a GAP in FHIR. Created a new extension: service-contactinfo to map HSDS contact.name, contact.title, contact.department, and contact.email",
"identity": "hsds"
} ],
"sliceName": "service-contactinfo"
}, {
"id": "HealthcareService.telecom.system",
"path": "HealthcareService.telecom.system",
"mapping": [ {
"map": "For Phone: \n if phone.type = 'voice' then system = 'phone' \n if phone.type = 'cell' then system = 'phone' \n if phone.type = 'fax' then system = 'fax' \n if phone.type = 'pager' then system = 'pager' \n if phone.type = 'text' then system = 'sms' \n if phone.type = 'textphone' then system = 'sms' \n if phone.type = 'video' then system = 'other' \nFor Email:\n Fixed value = 'email' \nFor Website URL:\n Fixed value = 'url' \nNote: There are multiple sources in HSDS for the telecom in FHIR so the system will be populated based on phone.type mapping or fixed value of 'email' or 'url' depending on the data populated. Drawn from the ContactPointSystem value set [http://hl7.org/fhir/ValueSet/contact-point-system]",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.telecom.value",
"path": "HealthcareService.telecom.value",
"mapping": [ {
"map": "For Phone: \n value = phone.number \nFor Email,\n value = service.email\nFor Website URL: \n value = service.url\nNote: For phone, HSDS service linkage is to phone table using service.id = phone.service_id.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.telecom.use",
"path": "HealthcareService.telecom.use",
"mapping": [ {
"map": "Fixed value = 'work' Note: This is a GAP in HSDS but since it is for work-related information, it is possible to set this to 'work' drawn from the ContactPointUse value set http://hl7.org/fhir/R4/valueset-contact-point-use.html.",
"identity": "hsds"
} ],
"fixedCode": "work"
}, {
"id": "HealthcareService.telecom.rank",
"path": "HealthcareService.telecom.rank",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, it is used to specify a preferred order in which to use a contact point. The parent Plan-Net profile indicates this is a Must Support element but is optional, So it can be excluded since there is no source.",
"identity": "hsds"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, it is used to specify a preferred order in which to use a contact point. The parent Plan-Net profile indicates this is a Must Support element but is optional, So it can be excluded since there is no source.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.telecom.period",
"path": "HealthcareService.telecom.period",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, this data element captures the time period when the contact point was/is in use. But it can be excluded since there is no source and it is optional.",
"identity": "hsds"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, this data element captures the time period when the contact point was/is in use. But it can be excluded since there is no source and it is optional.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.coverageArea",
"path": "HealthcareService.coverageArea",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Location" ]
} ],
"mapping": [ {
"map": "reference.display = service_area.service_area Note: FHIR HealthcareService.coverageArea is a reference of location resource so service_area cannot be directly used. Although generally not recommended, this is mapped to Reference.display since there is no other corresponding data element in FHIR to HSDS service area. If there are multiple service_area records for a given service, they are concatenated to make a single string.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.serviceProvisionCode",
"path": "HealthcareService.serviceProvisionCode",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. That element is the code describing healthcare service provision conditions such as 'free', 'disc' or 'cost'.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.eligibility",
"path": "HealthcareService.eligibility",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. Eligibility is currently out of scope for this release of the IG as Eligibility is not addressed by the HSDS eligibility specification (insufficient details to capture eligibility details as only a primary key (eligibility.id) and eligibility.service_id are included in the table.)",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.eligibility.id",
"path": "HealthcareService.eligibility.id",
"mapping": [ {
"map": "No Source. May be excluded from the mapping.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.eligibility.code",
"path": "HealthcareService.eligibility.code",
"mapping": [ {
"map": "No Source. May be excluded from the mapping.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.eligibility.comment",
"path": "HealthcareService.eligibility.comment",
"mapping": [ {
"map": "No Source. May be excluded from the mapping.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.program",
"path": "HealthcareService.program",
"short": "This example value set includes codes that describe Programs under which community-based organizations can organize the social services they deliver.",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/hsds/ValueSet/HumanServiceProgram"
},
"mapping": [ {
"map": "program[0].text = program.name Note: Since HSDS does not have any code for the program, only the text element of codeableConcept is mapped. Also, the program data element in FHIR is an array (list), so the program name from HSDS is populated in the first occurrence of the array.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.characteristic",
"path": "HealthcareService.characteristic",
"short": "This example value set includes codes that describe unique features that can be associated with community-based social services delivered at particular locations.",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/hsds/ValueSet/HumanServiceCharacteristic"
},
"mapping": [ {
"map": "characteristic[0].text = service.interpretation_services \nNote: This is not an obvious mapping but interpretation services is one of the characteristics of the service provision. Also, this data element in FHIR is an array (list), so the interpretation services data from HSDS is populated in the first occurrence of the array.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.communication",
"path": "HealthcareService.communication",
"mapping": [ {
"map": "communication[0].text = language.language. Note: This data element in FHIR is an array (list), so the language from HSDS is populated in the first occurrence of the array.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.referralMethod",
"path": "HealthcareService.referralMethod",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.appointmentRequired",
"path": "HealthcareService.appointmentRequired",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.availableTime",
"path": "HealthcareService.availableTime",
"mapping": [ {
"map": "Note: This structure identifies the days/times during a week this service may be provided. Linkage to the schedule is from service.id = schedule.service_id.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.availableTime.id",
"path": "HealthcareService.availableTime.id",
"mapping": [ {
"map": "schedule.id Note: This data element may be ignored as having the id for the schedule record isn't essential.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.availableTime.extension",
"path": "HealthcareService.availableTime.extension",
"mapping": [ {
"map": "extension[0].valueSting = schedule.description Note: This is not an obvious mapping but the extension is available to provide additional details. Since the extension is an array (list), the description will be populated in the first occurrence of the extension.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.availableTime.daysOfWeek",
"path": "HealthcareService.availableTime.daysOfWeek",
"mapping": [ {
"map": "schedule.byday Note: This is a comma-separated value of days of the week. e.g. SU,MO,TU,WE,TH,FR,SA. Where freq is MONTHLY each part can be preceded by a positive or negative integer to represent which occurrence in a month; e.g. 2MO is the second Monday in a month. -1FR is last Friday.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.availableTime.allDay",
"path": "HealthcareService.availableTime.allDay",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. May be derived from other HSDS data elements but may not be an accurate representation.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.availableTime.availableStartTime",
"path": "HealthcareService.availableTime.availableStartTime",
"mapping": [ {
"map": "schedule.opens_at Note: This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.)",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.availableTime.availableEndTime",
"path": "HealthcareService.availableTime.availableEndTime",
"mapping": [ {
"map": "schedule.closes_at Note: This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am EST.)",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.notAvailable",
"path": "HealthcareService.notAvailable",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.availabilityExceptions",
"path": "HealthcareService.availabilityExceptions",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. This is a Must Support but an optional element in the base Plan-Net profile.",
"identity": "hsds"
} ]
}, {
"id": "HealthcareService.endpoint",
"path": "HealthcareService.endpoint",
"mapping": [ {
"map": "No Source. Note: This is for the technical implementation of web services for the healthcare service and it is not for source-specific business data. It is marked as Must Support though optional in the Plan-Net profile. At this point, no service- specific web services have been identified so it may be ignored.",
"identity": "hsds"
} ]
} ]
},
"contact": [ {
"name": "HL7 Human and Social Services Work Group",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/hsswg/index.cfm",
"system": "url"
}, {
"value": "hsswg@lists.hl7.org",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
}