Left: | National Directory HealthcareService (http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-HealthcareService) |
Right: | National Directory HealthcareService (http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-HealthcareService) |
Information | StructureDefinition.date | Values for date differ: '2022-08-08T18:05:19+00:00' vs '2022-12-08T23:25:31+00:00' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-HealthcareService | ||
copyright | |||
date | 2022-08-08T18:05:19+00:00 | 2022-12-08T23:25:31+00:00 |
|
description | The HealthCareService resource typically describes services offered by an organization/practitioner at a location. The resource may be used to encompass a variety of services covering the entire healthcare spectrum, including promotion, prevention, diagnostics, pharmacy, hospital and ambulatory care, home care, long-term care, and other health-related and community services. | ||
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | NatlDirAttestHealthCareService | ||
publisher | HL7 Patient Administration Working Group | ||
purpose | |||
status | active | ||
title | National Directory HealthcareService | ||
type | HealthcareService | ||
url | http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-HealthcareService | ||
version | 1.0.0-ballot |
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HealthcareService | 0..* | NatlDirExHealthCareService | The details of a healthcare service available at a location | 0..* | NatlDirExHealthCareService | The details of a healthcare service available at a location | |||||||||||
id | Σ | 0..1 | string | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
versionId | Σ | 0..1 | id | Version specific identifier | Σ | 0..1 | id | Version specific identifier | |||||||||
lastUpdated | Σ | 1..1 | instant | When the resource version last changed | Σ | 1..1 | instant | When the resource version last changed | |||||||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | Σ | 0..1 | uri | Identifies where the resource comes from | |||||||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | Σ | 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. | Σ | 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". | Σ | 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 | ?!Σ | 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.
| 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
identifier | SΣ | 0..* | Identifier | External identifiers for this item | SΣ | 0..* | Identifier | External identifiers for this item | |||||||||
active | ?!Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true | ?!Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true | |||||||||
providedBy | SΣ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that provides this service | SΣ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that provides this service | |||||||||
category | SΣ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: HealthcareServiceCategoryVS (extensible) | SΣ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: Healthcare Service Category Value Set (extensible) | |||||||||
type | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareServiceTypeVS (extensible) | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) | |||||||||
specialty | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: SpecialtiesVS (required) | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Specialties Value Set (required) | |||||||||
location | SΣ | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) where service may be provided | SΣ | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) where service may be provided | |||||||||
name | SΣ | 0..1 | string | Description of service as presented to a consumer while searching | 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 | Σ | 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 | 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 | Σ | 0..1 | Attachment | Facilitates quick identification of the service | |||||||||
telecom | 0..* | ContactPoint | Contacts related to the healthcare service | 0..* | ContactPoint | Contacts related to the healthcare service | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | Σ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 | Σ | 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. | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | Σ | 0..1 | Period | Time period when the contact point was/is in use | |||||||||
coverageArea | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) service is intended for/available to | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) service is intended for/available to | |||||||||
serviceProvisionCode | S | 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. | S | 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 | S | 0..* | BackboneElement | Specific eligibility requirements required to use the service | S | 0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 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. | 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 | 0..1 | markdown | Describes the eligibility conditions for the service | |||||||||||
program | S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||||||
characteristic | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||||||
communication | S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||||||
referralMethod | S | 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. | S | 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 | 0..1 | boolean | If an appointment is required for access to this service | |||||||||||
availableTime | 0..* | BackboneElement | Times the Service Site is available | 0..* | BackboneElement | Times the Service Site is available | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 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. | 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 | 0..1 | boolean | Always available? e.g. 24 hour service | |||||||||||
availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||||||||
availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||||||||
notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | 0..* | BackboneElement | Not available during this time due to provided reason | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
description | 1..1 | string | Reason presented to the user explaining why time not available | 1..1 | string | Reason presented to the user explaining why time not available | |||||||||||
during | 0..1 | Period | Service not available from this date | 0..1 | Period | Service not available from this date | |||||||||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | 0..1 | string | Description of availability exceptions | |||||||||||
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||||||
Documentation for this format |