National Healthcare Directory Exchange
1.0.0-ballot - ballot US

This page is part of the National Healthcare Directory Exchange (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: National Directory HealthcareService

Official URL: http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-HealthcareService Version: 1.0.0-ballot
Active as of 2022-08-09 Computable Name: NatlDirExHealthCareService

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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from NatlDirEndpointQryHealthcareService

Summary

Must-Support: 8 elements

This structure is derived from NatlDirEndpointQryHealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*NatlDirEndpointQryHealthcareServiceThe details of a healthcare service available at a location
... extension:newpatients S0..*NewPatientsNew Patients
... identifier S0..*IdentifierExternal identifiers for this item
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered
... program S0..*CodeableConceptPrograms that this service is applicable to
... characteristic S0..*CodeableConceptCollection of characteristics (attributes)
... communication S0..*CodeableConceptThe language that this service is offered in
... referralMethod S0..*CodeableConceptWays that the service accepts referrals

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*NatlDirEndpointQryHealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)Rating
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
... newpatients SI0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
... deliverymethod 1..*(Complex)Delivery Method
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/delivery-method
... paymentaccepted 0..*CodeableConceptPayment Accepted
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/paymentAccepted
Binding: hl7VS-paymentMethodCode (required)
... requiredDocument 0..*(Complex)Required Document
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/requiredDocument
... fundingSource 0..*(Complex)Funding Source
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/fundingSource
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal identifiers for this item
... active ?!Σ1..1booleanWhether this HealthcareService record is in active use
Required Pattern: true
... providedBy SΣ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that provides this service
... category SΣ1..1CodeableConceptBroad category of service being performed or delivered
Binding: Healthcare Service Category Value Set (extensible)
... type SΣ0..*CodeableConceptType of service that may be delivered or performed
Binding: HealthcareService Type Value Set (extensible)
... specialty SΣ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Specialties Value Set (required)
... location SΣ0..*Reference(National Directory Endpoint Qry Exchange Location)Location(s) where service may be provided
... name SΣ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom 0..*ContactPointContacts related to the healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(National Directory Endpoint Qry Exchange Location)Location(s) service is intended for/available to
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility S0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... comment 0..1markdownDescribes the eligibility conditions for the service
... program S0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic S0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication S0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... referralMethod S0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*NatlDirEndpointQryHealthcareServiceThe details of a healthcare service available at a location
... newpatients I0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
... identifier Σ0..*IdentifierExternal identifiers for this item
... providedBy Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that provides this service
... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: HealthcareService Type Value Set (extensible)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Specialties Value Set (required)
... location Σ0..*Reference(National Directory Endpoint Qry Exchange Location)Location(s) where service may be provided
... name Σ0..1stringDescription of service as presented to a consumer while searching
... coverageArea 0..*Reference(National Directory Endpoint Qry Exchange Location)Location(s) service is intended for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... endpoint 0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

This structure is derived from NatlDirEndpointQryHealthcareService

Summary

Must-Support: 8 elements

Differential View

This structure is derived from NatlDirEndpointQryHealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*NatlDirEndpointQryHealthcareServiceThe details of a healthcare service available at a location
... extension:newpatients S0..*NewPatientsNew Patients
... identifier S0..*IdentifierExternal identifiers for this item
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered
... program S0..*CodeableConceptPrograms that this service is applicable to
... characteristic S0..*CodeableConceptCollection of characteristics (attributes)
... communication S0..*CodeableConceptThe language that this service is offered in
... referralMethod S0..*CodeableConceptWays that the service accepts referrals

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*NatlDirEndpointQryHealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)Rating
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
... newpatients SI0..*(Complex)New Patients
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
... deliverymethod 1..*(Complex)Delivery Method
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/delivery-method
... paymentaccepted 0..*CodeableConceptPayment Accepted
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/paymentAccepted
Binding: hl7VS-paymentMethodCode (required)
... requiredDocument 0..*(Complex)Required Document
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/requiredDocument
... fundingSource 0..*(Complex)Funding Source
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/fundingSource
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal identifiers for this item
... active ?!Σ1..1booleanWhether this HealthcareService record is in active use
Required Pattern: true
... providedBy SΣ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that provides this service
... category SΣ1..1CodeableConceptBroad category of service being performed or delivered
Binding: Healthcare Service Category Value Set (extensible)
... type SΣ0..*CodeableConceptType of service that may be delivered or performed
Binding: HealthcareService Type Value Set (extensible)
... specialty SΣ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Specialties Value Set (required)
... location SΣ0..*Reference(National Directory Endpoint Qry Exchange Location)Location(s) where service may be provided
... name SΣ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom 0..*ContactPointContacts related to the healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea S0..*Reference(National Directory Endpoint Qry Exchange Location)Location(s) service is intended for/available to
... serviceProvisionCode S0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility S0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... comment 0..1markdownDescribes the eligibility conditions for the service
... program S0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic S0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication S0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... referralMethod S0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
HealthcareService.meta.securityextensibleAll Security Labels
HealthcareService.meta.tagexampleCommonTags
HealthcareService.languagepreferredCommonLanguages
Max Binding: AllLanguages
HealthcareService.categoryextensibleHealthcareServiceCategoryVS
HealthcareService.typeextensibleHealthcareServiceTypeVS
HealthcareService.specialtyrequiredSpecialtiesVS
HealthcareService.telecom.systemrequiredContactPointSystem
HealthcareService.telecom.userequiredContactPointUse
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
HealthcareService.characteristicexample
HealthcareService.communicationpreferredCommonLanguages
Max Binding: AllLanguages
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek