National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndhPn-ldapi-HealthcareService | Version: 1.0.0-ballot | |||
Active as of 2025-02-07 | Computable Name: NdhPnLdApiHealthcareService |
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | NdhHealthcareService | The details of a healthcare service available at a location dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both new-patients-characteristics: If no new patients are accepted, no characteristics are allowed |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Network Profile) | Network associated with social service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both |
![]() ![]() ![]() ![]() |
0..1 | Attachment | Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 0..* | Identifier | External identifiers for this item ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() |
?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use ele-1: All FHIR elements must have a @value or children Required Pattern: true |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Healthcare Provider Taxonomy ![]() ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | string | Description of service as presented to a consumer while searching ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | boolean | If an appointment is required for access to this service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(Payer Provider Network Local Directory API Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
HealthcareService.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
HealthcareService.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | |
HealthcareService.category:HSC | required | HealthcareServiceCategoryVShttp://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceCategoryVS from this IG | |
HealthcareService.type | extensible | HealthcareServiceTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceTypeVS from this IG | |
HealthcareService.specialty | extensible | HealthcareProviderTaxonomy ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | |
HealthcareService.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
HealthcareService.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
This structure is derived from NdhHealthcareService
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | NdhHealthcareService | The details of a healthcare service available at a location | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | NewPatients | NDH New Patients |
![]() ![]() ![]() ![]() |
S | 0..* | DeliveryMethod | NDH Delivery Method |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() |
0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Broad category of service being performed or delivered | |
![]() ![]() ![]() |
0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided | |
![]() ![]() ![]() |
S | 0..1 | string | Additional description and/or any specific issues not covered elsewhere |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | ViaIntermediary | NDH Via Intermediary |
![]() ![]() ![]() ![]() |
S | 0..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The actual contact point details |
![]() ![]() ![]() |
0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to | |
![]() ![]() ![]() |
S | 0..1 | boolean | If an appointment is required for access to this service |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date |
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions |
![]() ![]() ![]() |
0..* | Reference(Payer Provider Network Local Directory API Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | NdhHealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | 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..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |||||
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Network Profile) | Network associated with social service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both | ||||
![]() ![]() ![]() ![]() |
0..1 | Attachment | Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External identifiers for this item | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(NDH Base Organization Profile) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Healthcare Provider Taxonomy ![]() | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
![]() ![]() ![]() |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
![]() ![]() ![]() |
Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible) | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Coded value for the eligibility Binding: Healthcare Service Eligibility Code Value Set (extensible) | |||||
![]() ![]() ![]() ![]() |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (extensible) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description (No ValueSet): (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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..1 | boolean | If an appointment is required for access to this service | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date | ||||
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions | ||||
![]() ![]() ![]() |
S | 0..* | Reference(Payer Provider Network Local Directory API Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
HealthcareService.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
HealthcareService.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
HealthcareService.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
HealthcareService.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
HealthcareService.category:HSC | required | HealthcareServiceCategoryVShttp://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceCategoryVS from this IG | ||||
HealthcareService.type | extensible | HealthcareServiceTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceTypeVS from this IG | ||||
HealthcareService.specialty | extensible | HealthcareProviderTaxonomy ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | ||||
HealthcareService.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.serviceProvisionCode | extensible | ServiceProvisionConditionshttp://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard | ||||
HealthcareService.eligibility.code | extensible | HealthcareServiceEligibilityCodeVShttp://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceEligibilityCodeVS from this IG | ||||
HealthcareService.program | extensible | Programhttp://hl7.org/fhir/ValueSet/program from the FHIR Standard | ||||
HealthcareService.characteristic | example | |||||
HealthcareService.communication | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard | ||||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
This structure is derived from NdhHealthcareService
Summary
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | NdhHealthcareService | The details of a healthcare service available at a location dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both new-patients-characteristics: If no new patients are accepted, no characteristics are allowed |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Network Profile) | Network associated with social service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both |
![]() ![]() ![]() ![]() |
0..1 | Attachment | Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 0..* | Identifier | External identifiers for this item ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() |
?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use ele-1: All FHIR elements must have a @value or children Required Pattern: true |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Healthcare Provider Taxonomy ![]() ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | string | Description of service as presented to a consumer while searching ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | boolean | If an appointment is required for access to this service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(Payer Provider Network Local Directory API Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
HealthcareService.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
HealthcareService.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | |
HealthcareService.category:HSC | required | HealthcareServiceCategoryVShttp://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceCategoryVS from this IG | |
HealthcareService.type | extensible | HealthcareServiceTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceTypeVS from this IG | |
HealthcareService.specialty | extensible | HealthcareProviderTaxonomy ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | |
HealthcareService.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
HealthcareService.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Differential View
This structure is derived from NdhHealthcareService
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | NdhHealthcareService | The details of a healthcare service available at a location | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | NewPatients | NDH New Patients |
![]() ![]() ![]() ![]() |
S | 0..* | DeliveryMethod | NDH Delivery Method |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() |
0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Broad category of service being performed or delivered | |
![]() ![]() ![]() |
0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided | |
![]() ![]() ![]() |
S | 0..1 | string | Additional description and/or any specific issues not covered elsewhere |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | ViaIntermediary | NDH Via Intermediary |
![]() ![]() ![]() ![]() |
S | 0..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The actual contact point details |
![]() ![]() ![]() |
0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to | |
![]() ![]() ![]() |
S | 0..1 | boolean | If an appointment is required for access to this service |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date |
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions |
![]() ![]() ![]() |
0..* | Reference(Payer Provider Network Local Directory API Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | NdhHealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | 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..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |||||
![]() ![]() ![]() ![]() |
SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Network Profile) | Network associated with social service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |||||
![]() ![]() ![]() ![]() |
C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both | ||||
![]() ![]() ![]() ![]() |
0..1 | Attachment | Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External identifiers for this item | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(NDH Base Organization Profile) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Healthcare Provider Taxonomy ![]() | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
![]() ![]() ![]() |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
![]() ![]() ![]() |
Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible) | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Coded value for the eligibility Binding: Healthcare Service Eligibility Code Value Set (extensible) | |||||
![]() ![]() ![]() ![]() |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (extensible) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description (No ValueSet): (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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..1 | boolean | If an appointment is required for access to this service | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date | ||||
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions | ||||
![]() ![]() ![]() |
S | 0..* | Reference(Payer Provider Network Local Directory API Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
HealthcareService.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
HealthcareService.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
HealthcareService.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
HealthcareService.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
HealthcareService.category:HSC | required | HealthcareServiceCategoryVShttp://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceCategoryVS from this IG | ||||
HealthcareService.type | extensible | HealthcareServiceTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceTypeVS from this IG | ||||
HealthcareService.specialty | extensible | HealthcareProviderTaxonomy ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | ||||
HealthcareService.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
HealthcareService.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
HealthcareService.serviceProvisionCode | extensible | ServiceProvisionConditionshttp://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard | ||||
HealthcareService.eligibility.code | extensible | HealthcareServiceEligibilityCodeVShttp://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceEligibilityCodeVS from this IG | ||||
HealthcareService.program | extensible | Programhttp://hl7.org/fhir/ValueSet/program from the FHIR Standard | ||||
HealthcareService.characteristic | example | |||||
HealthcareService.communication | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard | ||||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
This structure is derived from NdhHealthcareService
Summary
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron