National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndhPnQry-HealthcareService | Version: 1.0.0-ballot | |||
| Active as of 2023-07-30 | Computable Name: NdhPnQryHealthcareService | |||
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.
This structure is derived from NdhHealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HealthcareService | 0..* | NdhHealthcareService | The details of a healthcare service available at a location | |
  extension:newpatients | S | 0..* | NewPatients | NDH New Patients |
| extension:deliverymethod | S | 0..* | DeliveryMethod | NDH Delivery Method |
  identifier | ||||
 type | S | 0..1 | CodeableConcept | Description of identifier |
 value | S | 0..1 | string | The value that is unique |
 providedBy | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service | |
| category | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: Healthcare Service Category Value Set (extensible) | |
| location | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided | |
| comment | S | 0..1 | string | Additional description and/or any specific issues not covered elsewhere |
| telecom | S | 0..* | ContactPoint | Contacts related to the healthcare service |
| extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
| extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
| system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 0..1 | string | The actual contact point details |
| coverageArea | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to | |
| appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service |
| availableTime | S | 0..* | BackboneElement | Times the Service Site is available |
| daysOfWeek | S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
| allDay | S | 0..1 | boolean | Always available? e.g. 24 hour service |
| availableStartTime | S | 0..1 | time | Opening time of day (ignored if allDay = true) |
| availableEndTime | S | 0..1 | time | Closing time of day (ignored if allDay = true) |
| notAvailable | S | 0..* | BackboneElement | Not available during this time due to provided reason |
| description | S | 1..1 | string | Reason presented to the user explaining why time not available |
| during | S | 0..1 | Period | Service not available from this date |
| availabilityExceptions | S | 0..1 | string | Description of availability exceptions |
| endpoint | 0..* | Reference(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.category | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService | 0..* | NdhHealthcareService | The details of a healthcare service available at a location | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| rating | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |
| newpatients | SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients |
| deliverymethod | S | 0..* | (Complex) | NDH Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method |
| paymentaccepted | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) | |
| requiredDocument | 0..* | (Complex) | NDH Required Document URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument | |
| fundingSource | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource | |
| usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
| verification-status | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
| network | 0..* | Reference(NDH Base Network Profile) | Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |
| social-service-requirement | C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement |
| logo | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | Σ | 0..* | Identifier | External identifiers for this item |
| identifier-status | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
| 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. |
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| active | ?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true |
| providedBy | SΣ | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service |
 Slices for category | SΣ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by pattern:$this Binding: Healthcare Service Category Value Set (extensible) |
 category:HSC | SΣ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) |
| type | 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: Specialties Value Set (extensible) |
| location | SΣ | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided |
| name | SΣ | 0..1 | string | Description of service as presented to a consumer while searching |
| comment | SΣ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere |
| telecom | S | 0..* | ContactPoint | Contacts related to the healthcare service |
| contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
| via-intermediary | 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 |
| language-speak | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) | |
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 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. |
| coverageArea | S | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to |
| appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service |
| availableTime | S | 0..* | BackboneElement | Times the Service Site is available |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| daysOfWeek | S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. |
| allDay | S | 0..1 | boolean | Always available? e.g. 24 hour service |
| availableStartTime | S | 0..1 | time | Opening time of day (ignored if allDay = true) |
| availableEndTime | S | 0..1 | time | Closing time of day (ignored if allDay = true) |
| notAvailable | S | 0..* | BackboneElement | Not available during this time due to provided reason |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description | S | 1..1 | string | Reason presented to the user explaining why time not available |
| during | S | 0..1 | Period | Service not available from this date |
| availabilityExceptions | S | 0..1 | string | Description of availability exceptions |
| endpoint | S | 0..* | Reference(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.identifier.use | required | IdentifierUse |
| HealthcareService.identifier.type | extensible | Identifier Type Codes |
| HealthcareService.category | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System) |
| HealthcareService.category:HSC | required | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System) |
| HealthcareService.type | extensible | HealthcareServiceTypeVS (a valid code from HealthcareServiceTypeCS) |
| HealthcareService.specialty | extensible | SpecialtiesVS |
| HealthcareService.telecom.system | required | ContactPointSystem |
| HealthcareService.telecom.use | required | ContactPointUse |
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService | 0..* | NdhHealthcareService | 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 | |||||
| rating | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |||||
| newpatients | SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients | ||||
| deliverymethod | S | 0..* | (Complex) | NDH Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method | ||||
| paymentaccepted | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) | |||||
| requiredDocument | 0..* | (Complex) | NDH Required Document URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument | |||||
| fundingSource | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource | |||||
| usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
| verification-status | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
| network | 0..* | Reference(NDH Base Network Profile) | Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |||||
| social-service-requirement | C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement | ||||
| logo | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |||||
| 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 | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| identifier-status | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
| 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(NDH Base Organization Profile) | 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Σ | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service | ||||
| Slices for category | SΣ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by pattern:$this Binding: Healthcare Service Category Value Set (extensible) | ||||
| category:HSC | SΣ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) | ||||
| type | 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: Specialties Value Set (extensible) | ||||
| location | SΣ | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided | ||||
| name | SΣ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment | SΣ | 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 | S | 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 | |||||
| contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
| via-intermediary | 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 | ||||
| language-speak | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) | |||||
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 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. | ||||
| 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 | S | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to | ||||
| serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible) | |||||
| 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: Healthcare Service Eligibility Code Value Set (extensible) | |||||
| comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Healthcare Service Program Value Set (extensible) | |||||
| 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 | |||||
| program-requirement | 0..* | (Complex) | Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| 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: Healthcare Service Referral Method Value Set (extensible) | |||||
| appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service | ||||
| availableTime | S | 0..* | BackboneElement | Times the Service Site is available | ||||
| 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 | ||||
| daysOfWeek | S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||
| allDay | S | 0..1 | boolean | Always available? e.g. 24 hour service | ||||
| availableStartTime | S | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
| availableEndTime | S | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
| notAvailable | S | 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 | S | 1..1 | string | Reason presented to the user explaining why time not available | ||||
| during | S | 0..1 | Period | Service not available from this date | ||||
| availabilityExceptions | S | 0..1 | string | Description of availability exceptions | ||||
| endpoint | S | 0..* | Reference(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| 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 | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System) | ||||
| HealthcareService.category:HSC | required | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System) | ||||
| HealthcareService.type | extensible | HealthcareServiceTypeVS (a valid code from HealthcareServiceTypeCS) | ||||
| HealthcareService.specialty | extensible | SpecialtiesVS | ||||
| HealthcareService.telecom.system | required | ContactPointSystem | ||||
| HealthcareService.telecom.use | required | ContactPointUse | ||||
| HealthcareService.serviceProvisionCode | extensible | ServiceProvisionConditions | ||||
| HealthcareService.eligibility.code | extensible | HealthcareServiceEligibilityCodeVS | ||||
| HealthcareService.program | extensible | HealthcareServiceProgramVS (a valid code from Healthcare Program) | ||||
| HealthcareService.characteristic | example | |||||
| HealthcareService.communication | preferred | CommonLanguages
| ||||
| HealthcareService.referralMethod | extensible | HealthcareServiceReferralMethodVS (a valid code from Healthcare Service Referral Method Code System) | ||||
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
This structure is derived from NdhHealthcareService
Summary
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from NdhHealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService | 0..* | NdhHealthcareService | The details of a healthcare service available at a location | |
| extension:newpatients | S | 0..* | NewPatients | NDH New Patients |
| extension:deliverymethod | S | 0..* | DeliveryMethod | NDH Delivery Method |
| identifier | ||||
| type | S | 0..1 | CodeableConcept | Description of identifier |
| value | S | 0..1 | string | The value that is unique |
| providedBy | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service | |
| category | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: Healthcare Service Category Value Set (extensible) | |
| location | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided | |
| comment | S | 0..1 | string | Additional description and/or any specific issues not covered elsewhere |
| telecom | S | 0..* | ContactPoint | Contacts related to the healthcare service |
| extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
| extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
| system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 0..1 | string | The actual contact point details |
| coverageArea | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to | |
| appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service |
| availableTime | S | 0..* | BackboneElement | Times the Service Site is available |
| daysOfWeek | S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
| allDay | S | 0..1 | boolean | Always available? e.g. 24 hour service |
| availableStartTime | S | 0..1 | time | Opening time of day (ignored if allDay = true) |
| availableEndTime | S | 0..1 | time | Closing time of day (ignored if allDay = true) |
| notAvailable | S | 0..* | BackboneElement | Not available during this time due to provided reason |
| description | S | 1..1 | string | Reason presented to the user explaining why time not available |
| during | S | 0..1 | Period | Service not available from this date |
| availabilityExceptions | S | 0..1 | string | Description of availability exceptions |
| endpoint | 0..* | Reference(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.category | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService | 0..* | NdhHealthcareService | The details of a healthcare service available at a location | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| rating | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |
| newpatients | SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients |
| deliverymethod | S | 0..* | (Complex) | NDH Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method |
| paymentaccepted | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) | |
| requiredDocument | 0..* | (Complex) | NDH Required Document URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument | |
| fundingSource | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource | |
| usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
| verification-status | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
| network | 0..* | Reference(NDH Base Network Profile) | Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |
| social-service-requirement | C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement |
| logo | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External identifiers for this item |
| identifier-status | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
| 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. |
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| active | ?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true |
| providedBy | SΣ | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service |
| Slices for category | SΣ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by pattern:$this Binding: Healthcare Service Category Value Set (extensible) |
| category:HSC | SΣ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) |
| type | 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: Specialties Value Set (extensible) |
| location | SΣ | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided |
| name | SΣ | 0..1 | string | Description of service as presented to a consumer while searching |
| comment | SΣ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere |
| telecom | S | 0..* | ContactPoint | Contacts related to the healthcare service |
| contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
| via-intermediary | 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 |
| language-speak | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) | |
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 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. |
| coverageArea | S | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to |
| appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service |
| availableTime | S | 0..* | BackboneElement | Times the Service Site is available |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| daysOfWeek | S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. |
| allDay | S | 0..1 | boolean | Always available? e.g. 24 hour service |
| availableStartTime | S | 0..1 | time | Opening time of day (ignored if allDay = true) |
| availableEndTime | S | 0..1 | time | Closing time of day (ignored if allDay = true) |
| notAvailable | S | 0..* | BackboneElement | Not available during this time due to provided reason |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description | S | 1..1 | string | Reason presented to the user explaining why time not available |
| during | S | 0..1 | Period | Service not available from this date |
| availabilityExceptions | S | 0..1 | string | Description of availability exceptions |
| endpoint | S | 0..* | Reference(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.identifier.use | required | IdentifierUse |
| HealthcareService.identifier.type | extensible | Identifier Type Codes |
| HealthcareService.category | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System) |
| HealthcareService.category:HSC | required | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System) |
| HealthcareService.type | extensible | HealthcareServiceTypeVS (a valid code from HealthcareServiceTypeCS) |
| HealthcareService.specialty | extensible | SpecialtiesVS |
| HealthcareService.telecom.system | required | ContactPointSystem |
| HealthcareService.telecom.use | required | ContactPointUse |
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService | 0..* | NdhHealthcareService | 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 | |||||
| rating | 0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |||||
| newpatients | SC | 0..* | (Complex) | NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients | ||||
| deliverymethod | S | 0..* | (Complex) | NDH Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method | ||||
| paymentaccepted | 0..* | CodeableConcept | NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) | |||||
| requiredDocument | 0..* | (Complex) | NDH Required Document URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument | |||||
| fundingSource | 0..* | (Complex) | NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource | |||||
| usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
| verification-status | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
| network | 0..* | Reference(NDH Base Network Profile) | Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |||||
| social-service-requirement | C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement | ||||
| logo | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |||||
| 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 | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| identifier-status | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
| 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(NDH Base Organization Profile) | 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Σ | 0..1 | Reference(Payer Provider Network Query Organization Profile) | Organization that provides this service | ||||
| Slices for category | SΣ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by pattern:$this Binding: Healthcare Service Category Value Set (extensible) | ||||
| category:HSC | SΣ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) | ||||
| type | 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: Specialties Value Set (extensible) | ||||
| location | SΣ | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) where service may be provided | ||||
| name | SΣ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment | SΣ | 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 | S | 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 | |||||
| contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
| via-intermediary | 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 | ||||
| language-speak | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) | |||||
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 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. | ||||
| 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 | S | 0..* | Reference(Payer Provider Network Query Location Profile) | Location(s) service is intended for/available to | ||||
| serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible) | |||||
| 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: Healthcare Service Eligibility Code Value Set (extensible) | |||||
| comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Healthcare Service Program Value Set (extensible) | |||||
| 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 | |||||
| program-requirement | 0..* | (Complex) | Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| 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: Healthcare Service Referral Method Value Set (extensible) | |||||
| appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service | ||||
| availableTime | S | 0..* | BackboneElement | Times the Service Site is available | ||||
| 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 | ||||
| daysOfWeek | S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||
| allDay | S | 0..1 | boolean | Always available? e.g. 24 hour service | ||||
| availableStartTime | S | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
| availableEndTime | S | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
| notAvailable | S | 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 | S | 1..1 | string | Reason presented to the user explaining why time not available | ||||
| during | S | 0..1 | Period | Service not available from this date | ||||
| availabilityExceptions | S | 0..1 | string | Description of availability exceptions | ||||
| endpoint | S | 0..* | Reference(Payer Provider Network Query Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| 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 | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System) | ||||
| HealthcareService.category:HSC | required | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System) | ||||
| HealthcareService.type | extensible | HealthcareServiceTypeVS (a valid code from HealthcareServiceTypeCS) | ||||
| HealthcareService.specialty | extensible | SpecialtiesVS | ||||
| HealthcareService.telecom.system | required | ContactPointSystem | ||||
| HealthcareService.telecom.use | required | ContactPointUse | ||||
| HealthcareService.serviceProvisionCode | extensible | ServiceProvisionConditions | ||||
| HealthcareService.eligibility.code | extensible | HealthcareServiceEligibilityCodeVS | ||||
| HealthcareService.program | extensible | HealthcareServiceProgramVS (a valid code from Healthcare Program) | ||||
| HealthcareService.characteristic | example | |||||
| HealthcareService.communication | preferred | CommonLanguages
| ||||
| HealthcareService.referralMethod | extensible | HealthcareServiceReferralMethodVS (a valid code from Healthcare Service Referral Method Code System) | ||||
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
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
IG © 2023+ HL7 International - Patient Administration Work Group. Package hl7.fhir.us.ndh#1.0.0-ballot based on FHIR 4.0.1. Generated 2023-07-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change