FHIR Human Services Directory
1.0.0 - STU1
FHIR Human Services Directory
1.0.0 - STU1
This page is part of the FHIR IG Human Services Directory (v1.0.0: STU1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-HealthcareService | Version: 1.0.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: HSDHealthcareService | ||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |
  id | 0..1 | id | Logical id of this artifact | |
 meta | 0..1 | Meta | Metadata about the resource | |
  lastUpdated | 1..1 | instant | When the resource version last changed | |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 newpatients | 0..0 | (Complex) | ||
| deliverymethod | 0..0 | (Complex) | ||
| identifier | 0..* | Identifier | External identifiers for this item | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
| type | S | 0..1 | CodeableConcept | Description of identifier |
| system | 0..1 | uri | The namespace for the identifier value | |
| value | S | 0..1 | string | The value that is unique |
| period | 0..1 | Period | Time period when id is/was valid for use | |
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| active | S | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true |
 providedBy | S | 1..1 | Reference(HSDOrganization) | Organization that provides this service |
| category | 1..1 | CodeableConcept | 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: Human Service Category VS (example) | |
| type | 0..* | CodeableConcept | 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: Human Service Type VS (example) | |
| specialty | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Non-Individual Specialties (preferred) | |
| location | S | 0..* | Reference(HSDLocation) | Location(s) where service may be provided |
| name | S | 0..1 | string | Description of service as presented to a consumer while searching |
| comment | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | |
| extraDetails | 0..1 | markdown | Extra details about the service that can't be placed in the other fields | |
| photo | 0..1 | Attachment | Facilitates quick identification of the service | |
| telecom | 0..* | ContactPoint | Contacts related to the healthcare service | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| contactpoint-availabletime | 0..0 | (Complex) | ||
| via-intermediary | 0..0 | Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) | ||
| service-contactinfo | 0..* | (Complex) | Additional contact information for services URL: http://hl7.org/fhir/us/hsds/StructureDefinition/service-contactinfo | |
| system | 0..1 | code | phone | fax | email | pager | url | sms | other | |
| value | 0..1 | string | The actual contact point details | |
| use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| rank | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | 0..1 | Period | Time period when the contact point was/is in use | |
| coverageArea | 0..* | Reference(HSDLocation) | Location(s) service is intended for/available to | |
| serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered | |
| eligibility | 0..* | BackboneElement | Specific eligibility requirements required to use the service | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| code | 0..1 | CodeableConcept | Coded value for the eligibility | |
| comment | 0..1 | markdown | Describes the eligibility conditions for the service | |
| program | 0..* | CodeableConcept | This example value set includes codes that describe Programs under which community-based organizations can organize the social services they deliver. Binding: Human Service Program VS (example) | |
| characteristic | 0..* | CodeableConcept | This example value set includes codes that describe unique features that can be associated with community-based social services delivered at particular locations. Binding: Human Service Characteristic VS (example) | |
| communication | 0..* | CodeableConcept | The language that this service is offered in | |
| referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals | |
| appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |
| availableTime | 0..* | BackboneElement | Times the Service Site is available | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Extension | |
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun | |
| allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |
| availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |
| availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |
| notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.category | example | HumanServiceCategoryVS |
| HealthcareService.type | example | HumanServiceTypeVS |
| HealthcareService.specialty | preferred | NonIndividualSpecialtiesVS |
| HealthcareService.program | example | HumanServiceProgramVS |
| HealthcareService.characteristic | example | HumanServiceCharacteristicVS |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External identifiers for this item | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true | ||||
| providedBy | SΣ | 1..1 | Reference(HSDOrganization) | Organization that provides this service | ||||
| category | Σ | 1..1 | CodeableConcept | 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: Human Service Category VS (example) | ||||
| type | Σ | 0..* | CodeableConcept | 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: Human Service Type VS (example) | ||||
| specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Non-Individual Specialties (preferred) | ||||
| location | SΣ | 0..* | Reference(HSDLocation) | Location(s) where service may be provided | ||||
| name | SΣ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails | 0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
| telecom | 0..* | ContactPoint | Contacts related to the healthcare service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| service-contactinfo | 0..* | (Complex) | Additional contact information for services URL: http://hl7.org/fhir/us/hsds/StructureDefinition/service-contactinfo | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| coverageArea | 0..* | Reference(HSDLocation) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |||||
| eligibility | 0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available. | |||||
| comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program | 0..* | CodeableConcept | This example value set includes codes that describe Programs under which community-based organizations can organize the social services they deliver. Binding: Human Service Program VS (example) | |||||
| characteristic | 0..* | CodeableConcept | This example value set includes codes that describe unique features that can be associated with community-based social services delivered at particular locations. Binding: Human Service Characteristic VS (example) | |||||
| communication | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. | |||||
| appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |||||
| availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Extension | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| HealthcareService.identifier.use | required | IdentifierUse | ||||
| HealthcareService.identifier.type | extensible | Identifier Type Codes | ||||
| HealthcareService.category | example | HumanServiceCategoryVS | ||||
| HealthcareService.type | example | HumanServiceTypeVS | ||||
| HealthcareService.specialty | preferred | NonIndividualSpecialtiesVS | ||||
| HealthcareService.telecom.system | required | ContactPointSystem | ||||
| HealthcareService.telecom.use | required | Fixed Value: work | ||||
| HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions | ||||
| HealthcareService.eligibility.code | example | |||||
| HealthcareService.program | example | HumanServiceProgramVS | ||||
| HealthcareService.characteristic | example | HumanServiceCharacteristicVS | ||||
| HealthcareService.communication | preferred | CommonLanguages
| ||||
| HealthcareService.referralMethod | example | ReferralMethod | ||||
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External identifiers for this item | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true | ||||
| providedBy | SΣ | 1..1 | Reference(HSDOrganization) | Organization that provides this service | ||||
| category | Σ | 1..1 | CodeableConcept | 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: Human Service Category VS (example) | ||||
| type | Σ | 0..* | CodeableConcept | 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: Human Service Type VS (example) | ||||
| specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Non-Individual Specialties (preferred) | ||||
| location | SΣ | 0..* | Reference(HSDLocation) | Location(s) where service may be provided | ||||
| name | SΣ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails | 0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
| telecom | 0..* | ContactPoint | Contacts related to the healthcare service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| service-contactinfo | 0..* | (Complex) | Additional contact information for services URL: http://hl7.org/fhir/us/hsds/StructureDefinition/service-contactinfo | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| coverageArea | 0..* | Reference(HSDLocation) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |||||
| eligibility | 0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available. | |||||
| comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program | 0..* | CodeableConcept | This example value set includes codes that describe Programs under which community-based organizations can organize the social services they deliver. Binding: Human Service Program VS (example) | |||||
| characteristic | 0..* | CodeableConcept | This example value set includes codes that describe unique features that can be associated with community-based social services delivered at particular locations. Binding: Human Service Characteristic VS (example) | |||||
| communication | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. | |||||
| appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |||||
| availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Extension | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
| during | 0..1 | Period | Service not available from this date | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| HealthcareService.meta.security | extensible | All Security Labels | ||||
| HealthcareService.meta.tag | example | CommonTags | ||||
| HealthcareService.language | preferred | CommonLanguages
| ||||
| HealthcareService.identifier.use | required | IdentifierUse | ||||
| HealthcareService.identifier.type | extensible | Identifier Type Codes | ||||
| HealthcareService.category | example | HumanServiceCategoryVS | ||||
| HealthcareService.type | example | HumanServiceTypeVS | ||||
| HealthcareService.specialty | preferred | NonIndividualSpecialtiesVS | ||||
| HealthcareService.telecom.system | required | ContactPointSystem | ||||
| HealthcareService.telecom.use | required | Fixed Value: work | ||||
| HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions | ||||
| HealthcareService.eligibility.code | example | |||||
| HealthcareService.program | example | HumanServiceProgramVS | ||||
| HealthcareService.characteristic | example | HumanServiceCharacteristicVS | ||||
| HealthcareService.communication | preferred | CommonLanguages
| ||||
| HealthcareService.referralMethod | example | ReferralMethod | ||||
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
This structure is derived from HealthcareService
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 6 elements
Fixed Value: 1 element
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Differential View
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |
| id | 0..1 | id | Logical id of this artifact | |
| meta | 0..1 | Meta | Metadata about the resource | |
| lastUpdated | 1..1 | instant | When the resource version last changed | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| newpatients | 0..0 | (Complex) | ||
| deliverymethod | 0..0 | (Complex) | ||
| identifier | 0..* | Identifier | External identifiers for this item | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
| type | S | 0..1 | CodeableConcept | Description of identifier |
| system | 0..1 | uri | The namespace for the identifier value | |
| value | S | 0..1 | string | The value that is unique |
| period | 0..1 | Period | Time period when id is/was valid for use | |
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| active | S | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true |
| providedBy | S | 1..1 | Reference(HSDOrganization) | Organization that provides this service |
| category | 1..1 | CodeableConcept | 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: Human Service Category VS (example) | |
| type | 0..* | CodeableConcept | 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: Human Service Type VS (example) | |
| specialty | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Non-Individual Specialties (preferred) | |
| location | S | 0..* | Reference(HSDLocation) | Location(s) where service may be provided |
| name | S | 0..1 | string | Description of service as presented to a consumer while searching |
| comment | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | |
| extraDetails | 0..1 | markdown | Extra details about the service that can't be placed in the other fields | |
| photo | 0..1 | Attachment | Facilitates quick identification of the service | |
| telecom | 0..* | ContactPoint | Contacts related to the healthcare service | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| contactpoint-availabletime | 0..0 | (Complex) | ||
| via-intermediary | 0..0 | Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) | ||
| service-contactinfo | 0..* | (Complex) | Additional contact information for services URL: http://hl7.org/fhir/us/hsds/StructureDefinition/service-contactinfo | |
| system | 0..1 | code | phone | fax | email | pager | url | sms | other | |
| value | 0..1 | string | The actual contact point details | |
| use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| rank | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | 0..1 | Period | Time period when the contact point was/is in use | |
| coverageArea | 0..* | Reference(HSDLocation) | Location(s) service is intended for/available to | |
| serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered | |
| eligibility | 0..* | BackboneElement | Specific eligibility requirements required to use the service | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| code | 0..1 | CodeableConcept | Coded value for the eligibility | |
| comment | 0..1 | markdown | Describes the eligibility conditions for the service | |
| program | 0..* | CodeableConcept | This example value set includes codes that describe Programs under which community-based organizations can organize the social services they deliver. Binding: Human Service Program VS (example) | |
| characteristic | 0..* | CodeableConcept | This example value set includes codes that describe unique features that can be associated with community-based social services delivered at particular locations. Binding: Human Service Characteristic VS (example) | |
| communication | 0..* | CodeableConcept | The language that this service is offered in | |
| referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals | |
| appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |
| availableTime | 0..* | BackboneElement | Times the Service Site is available | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Extension | |
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun | |
| allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |
| availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |
| availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |
| notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.category | example | HumanServiceCategoryVS |
| HealthcareService.type | example | HumanServiceTypeVS |
| HealthcareService.specialty | preferred | NonIndividualSpecialtiesVS |
| HealthcareService.program | example | HumanServiceProgramVS |
| HealthcareService.characteristic | example | HumanServiceCharacteristicVS |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External identifiers for this item | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true | ||||
| providedBy | SΣ | 1..1 | Reference(HSDOrganization) | Organization that provides this service | ||||
| category | Σ | 1..1 | CodeableConcept | 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: Human Service Category VS (example) | ||||
| type | Σ | 0..* | CodeableConcept | 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: Human Service Type VS (example) | ||||
| specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Non-Individual Specialties (preferred) | ||||
| location | SΣ | 0..* | Reference(HSDLocation) | Location(s) where service may be provided | ||||
| name | SΣ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails | 0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
| telecom | 0..* | ContactPoint | Contacts related to the healthcare service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| service-contactinfo | 0..* | (Complex) | Additional contact information for services URL: http://hl7.org/fhir/us/hsds/StructureDefinition/service-contactinfo | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| coverageArea | 0..* | Reference(HSDLocation) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |||||
| eligibility | 0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available. | |||||
| comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program | 0..* | CodeableConcept | This example value set includes codes that describe Programs under which community-based organizations can organize the social services they deliver. Binding: Human Service Program VS (example) | |||||
| characteristic | 0..* | CodeableConcept | This example value set includes codes that describe unique features that can be associated with community-based social services delivered at particular locations. Binding: Human Service Characteristic VS (example) | |||||
| communication | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. | |||||
| appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |||||
| availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Extension | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| HealthcareService.identifier.use | required | IdentifierUse | ||||
| HealthcareService.identifier.type | extensible | Identifier Type Codes | ||||
| HealthcareService.category | example | HumanServiceCategoryVS | ||||
| HealthcareService.type | example | HumanServiceTypeVS | ||||
| HealthcareService.specialty | preferred | NonIndividualSpecialtiesVS | ||||
| HealthcareService.telecom.system | required | ContactPointSystem | ||||
| HealthcareService.telecom.use | required | Fixed Value: work | ||||
| HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions | ||||
| HealthcareService.eligibility.code | example | |||||
| HealthcareService.program | example | HumanServiceProgramVS | ||||
| HealthcareService.characteristic | example | HumanServiceCharacteristicVS | ||||
| HealthcareService.communication | preferred | CommonLanguages
| ||||
| HealthcareService.referralMethod | example | ReferralMethod | ||||
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External identifiers for this item | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true | ||||
| providedBy | SΣ | 1..1 | Reference(HSDOrganization) | Organization that provides this service | ||||
| category | Σ | 1..1 | CodeableConcept | 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: Human Service Category VS (example) | ||||
| type | Σ | 0..* | CodeableConcept | 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: Human Service Type VS (example) | ||||
| specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Non-Individual Specialties (preferred) | ||||
| location | SΣ | 0..* | Reference(HSDLocation) | Location(s) where service may be provided | ||||
| name | SΣ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails | 0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
| telecom | 0..* | ContactPoint | Contacts related to the healthcare service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| service-contactinfo | 0..* | (Complex) | Additional contact information for services URL: http://hl7.org/fhir/us/hsds/StructureDefinition/service-contactinfo | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| coverageArea | 0..* | Reference(HSDLocation) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |||||
| eligibility | 0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available. | |||||
| comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program | 0..* | CodeableConcept | This example value set includes codes that describe Programs under which community-based organizations can organize the social services they deliver. Binding: Human Service Program VS (example) | |||||
| characteristic | 0..* | CodeableConcept | This example value set includes codes that describe unique features that can be associated with community-based social services delivered at particular locations. Binding: Human Service Characteristic VS (example) | |||||
| communication | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. | |||||
| appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |||||
| availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Extension | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
| during | 0..1 | Period | Service not available from this date | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| HealthcareService.meta.security | extensible | All Security Labels | ||||
| HealthcareService.meta.tag | example | CommonTags | ||||
| HealthcareService.language | preferred | CommonLanguages
| ||||
| HealthcareService.identifier.use | required | IdentifierUse | ||||
| HealthcareService.identifier.type | extensible | Identifier Type Codes | ||||
| HealthcareService.category | example | HumanServiceCategoryVS | ||||
| HealthcareService.type | example | HumanServiceTypeVS | ||||
| HealthcareService.specialty | preferred | NonIndividualSpecialtiesVS | ||||
| HealthcareService.telecom.system | required | ContactPointSystem | ||||
| HealthcareService.telecom.use | required | Fixed Value: work | ||||
| HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions | ||||
| HealthcareService.eligibility.code | example | |||||
| HealthcareService.program | example | HumanServiceProgramVS | ||||
| HealthcareService.characteristic | example | HumanServiceCharacteristicVS | ||||
| HealthcareService.communication | preferred | CommonLanguages
| ||||
| HealthcareService.referralMethod | example | ReferralMethod | ||||
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
This structure is derived from HealthcareService
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 6 elements
Fixed Value: 1 element
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 Human and Social Services Work Group. Package hl7.fhir.us.hsds#1.0.0 based on FHIR 4.0.1. Generated 2023-10-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change