Validated Healthcare Directory IG STU1 Draft for Comment

This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.2.0. . For a full list of available versions, see the Directory of published versions

1.0 - StructureDefinition: vhdir-healthcareservice - Content

This profile sets minimum expectations for searching for and fetching information associated with a healthcare service. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the healthcareService resource when using this profile.

Background & Scope

The healthcareService resource typically describes services offered by an organization at a location. The resource may be used to encompass a variety of services covering the entire healthcare spectrum, including promotion, prevention, diagnstics, hospital and ambulatory care, home care, long-term care, and other health-related and community services.

This profile makes relatively few changes to the base FHIR resource. It adds an extension to represent the coverage area of a service, rather than using a reference to a location resource in healthcareService.coverageArea (because the location resource only represents a defined point, rather than a geographic area/region). It also includes optional extensions to describe whether the service is accepting new patients.

Examples:

The following are example uses for the vhdir-healthcareService profile:

  • TBD

Mandatory Data Elements

There are no mandatory attributes for the healthcareService resource. However, some attributes have mandatory components if they are included in the resource (including extensions). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

  1. For each indication of when a service is not available, a description of why the service is unavailable in healthcareService.notAvailable.description
  2. For each geographic area described for the service, one URI to a KML or GeoJSON object defining the region/area in healthcareService.boundary.region (extension)
  3. For each indication of whether the service is accepting new patients, one boolean value in healthcareService.newPatients.acceptingPatients (extension)

Profile specific implementation guidance:

  • TBD

Extensions:

  1. Restriction (0..*) - indicates restrictions on the use/release of information associated with a healthareService
  2. Boundary (0..*) - indicates a region/area in which the service is available, consisting of:
    1. Region (1..1) - a URI to a KML or GeoJSON object defining the region/area
    2. LocalName (0..*) - a friendly description of the region/area (such as the colloquial name of the region)
  3. NewPatients (0..*) - indicates whether the service is accepting new patients, consisting of:
    1. AcceptingPatients (1.1) - a value of ‘true’ means the service is accepting new patients, ‘false’ means it is not
    2. Network (0..1) - indicates whether the service is accepting new patients for a particular health provider insurance network
  4. NewPatientProfile (0..1) - a description of the type of patients the service accepts (e.g. pediatric only)

Terminology

TBD

1.2 - Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/ig/vhdir/StructureDefinition/vhdir-healthcareservice

This profile builds on HealthcareService.

This profile was published on Wed Oct 18 01:21:21 AEDT 2017 as a draft by null.

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

Complete Summary of the Mandatory Requirements

There are no mandatory attributes for the healthcareService resource. However, some attributes have mandatory components if they are included in the resource (including extensions):

  1. For each indication of when a service is not available, a description of why the service is unavailable in healthcareService.notAvailable.description
  2. For each geographic area described for the service, one URI to a KML or GeoJSON object defining the region/area in healthcareService.boundary.region (extension)
  3. For each indication of whether the service is accepting new patients, one boolean value in healthcareService.newPatients.acceptingPatients (extension)
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*The details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifiers for this item
... active ?!Σ0..1booleanWhether this HealthcareService record is in active use
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..1CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Practice Setting Code Value Set (preferred)
... location Σ0..*Reference(Location)Location(s) where service may be provided
... name Σ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..1stringExtra details about the service that can't be placed in the other fields
... telecom 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is inteded for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example)
... eligibility 0..1CodeableConceptSpecific eligibility requirements required to use the service
Binding: (unbound) (example)
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that categorize the service
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example)
... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... 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 I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Complete Summary of the Mandatory Requirements

There are no mandatory attributes for the healthcareService resource. However, some attributes have mandatory components if they are included in the resource (including extensions):

  1. For each indication of when a service is not available, a description of why the service is unavailable in healthcareService.notAvailable.description
  2. For each geographic area described for the service, one URI to a KML or GeoJSON object defining the region/area in healthcareService.boundary.region (extension)
  3. For each indication of whether the service is accepting new patients, one boolean value in healthcareService.newPatients.acceptingPatients (extension)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService I0..*The details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifiers for this item
... active ?!Σ0..1booleanWhether this HealthcareService record is in active use
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..1CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example)
... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Practice Setting Code Value Set (preferred)
... location Σ0..*Reference(Location)Location(s) where service may be provided
... name Σ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..1stringExtra details about the service that can't be placed in the other fields
... telecom 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is inteded for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example)
... eligibility 0..1CodeableConceptSpecific eligibility requirements required to use the service
Binding: (unbound) (example)
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that categorize the service
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example)
... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... 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 I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

1.3 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.

TBD