Validated Healthcare Directory, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. See the Directory of published versions
Defining URL: | http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-healthcareservice |
Version: | 0.2.0 |
Name: | VhdirHealthcareService |
Title: | VhDir Healthcare Service |
Status: | Active as of 2017-10-17 10:21:21-0400 |
Definition: | Defines the basic constraints and extensions on the HealthcareService resource for use in a Validated Healthcare Directory |
Publisher: | HL7 International - Patient Administration Work Group |
Copyright: | HL7 International |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-healthcareservice
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/practitioner 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 modifies the base HealthcareService resource in the following manner:
Constrains the cardinality of healthcareService.active
(1..1), healthcareService.telecom.system
(1..1), and healthcareService.telecom.value
(1..1)
All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile
Adds extensions:
Examples:
The following are example uses for the vhdir-healthcareservice profile:
Mandatory Data Elements
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
healthcareService.active
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from HealthcareService
Summary
Mandatory: 1 element (3 nested mandatory elements)
Must-Support: 48 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from HealthcareService
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | HealthcareService | The details of a healthcare service available at a location | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() | S | 0..* | (Complex) | Whether the services is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients |
![]() ![]() ![]() | S | 0..* | Identifier | External identifiers for this item |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() | S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() | S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() | S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | S | 1..1 | boolean | Whether this HealthcareService record is in active use |
![]() ![]() ![]() | S | 0..1 | Reference(VhDir Organization) | Organization that provides this service |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Broad category of service being performed or delivered |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Type of service that may be delivered or performed |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Specialties handled by the HealthcareService |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Location) | 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 |
![]() ![]() ![]() | S | 0..1 | markdown | Extra details about the service that can't be placed in the other fields |
![]() ![]() ![]() | S | 0..1 | Attachment | Facilitates quick identification of the service |
![]() ![]() ![]() | S | 0..* | ContactPoint | Contacts related to the healthcare service |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() | S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Location) | Location(s) service is intended for/available to |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Conditions under which service is available/offered |
![]() ![]() ![]() | S | 0..* | BackboneElement | Specific eligibility requirements required to use the service Binding: VhDir Healthcare Service Eligibility (example) |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Coded value for the eligibility |
![]() ![]() ![]() ![]() | S | 0..1 | markdown | Describes the eligibility conditions for the service |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Programs that this service is applicable to |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: VhDir Healthcare Service Characteristic (example) |
![]() ![]() ![]() | S | 0..* | CodeableConcept | The language that this service is offered in |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Ways that the service accepts referrals |
![]() ![]() ![]() | 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 |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | HealthcareService | The details of a healthcare service available at a location | |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: 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 | |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() | S | 0..* | (Complex) | Whether the services is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣ | 0..* | Identifier | External identifiers for this item |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() | ?!SΣ | 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. |
![]() ![]() ![]() ![]() | SΣ | 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 |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use |
![]() ![]() ![]() | SΣ | 0..1 | Reference(VhDir Organization) | Organization that provides this service |
![]() ![]() ![]() | SΣ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. |
![]() ![]() ![]() | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). |
![]() ![]() ![]() | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. |
![]() ![]() ![]() | SΣ | 0..* | Reference(VhDir Location) | 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 |
![]() ![]() ![]() | S | 0..1 | markdown | Extra details about the service that can't be placed in the other fields |
![]() ![]() ![]() | SΣ | 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 | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Location) | Location(s) service is intended for/available to |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. |
![]() ![]() ![]() | S | 0..* | 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 |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available. |
![]() ![]() ![]() ![]() | S | 0..1 | markdown | Describes the eligibility conditions for the service |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: VhDir Healthcare Service Characteristic (example) |
![]() ![]() ![]() | S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. |
![]() ![]() ![]() | S | 0..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(VhDir Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | HealthcareService | The details of a healthcare service available at a location | |
![]() ![]() ![]() | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | |
![]() ![]() ![]() | 0..* | (Complex) | Whether the services is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients | |
![]() ![]() ![]() | Σ | 0..* | Identifier | External identifiers for this item |
![]() ![]() ![]() ![]() | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir 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 . |
![]() ![]() ![]() ![]() | Σ | 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 |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!Σ | 1..1 | boolean | Whether this HealthcareService record is in active use |
![]() ![]() ![]() | Σ | 0..1 | Reference(VhDir Organization) | Organization that provides this service |
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. |
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). |
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. |
![]() ![]() ![]() | Σ | 0..* | Reference(VhDir Location) | Location(s) where service may be provided |
![]() ![]() ![]() | Σ | 0..1 | string | Description of service as presented to a consumer while searching |
![]() ![]() ![]() | Σ | 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 |
![]() ![]() ![]() | 0..* | ContactPoint | Contacts related to the healthcare service | |
![]() ![]() ![]() ![]() | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | |
![]() ![]() ![]() ![]() | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | |
![]() ![]() ![]() ![]() | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() | Σ | 1..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 |
![]() ![]() ![]() | 0..* | Reference(VhDir Location) | Location(s) service is intended for/available to | |
![]() ![]() ![]() | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |
![]() ![]() ![]() | 0..* | BackboneElement | Specific eligibility requirements required to use the service | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available. | |
![]() ![]() ![]() ![]() | 0..1 | markdown | Describes the eligibility conditions for the service | |
![]() ![]() ![]() | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |
![]() ![]() ![]() | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: VhDir Healthcare Service Characteristic (example) | |
![]() ![]() ![]() | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred) Max Binding: AllLanguages: 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. | |
![]() ![]() ![]() | 0..1 | boolean | If an appointment is required for access to this service | |
![]() ![]() ![]() | 0..* | BackboneElement | Times the Service Site is available | |
![]() ![]() ![]() ![]() | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |
![]() ![]() ![]() ![]() | 0..1 | boolean | Always available? e.g. 24 hour service | |
![]() ![]() ![]() ![]() | 0..1 | time | Opening time of day (ignored if allDay = true) | |
![]() ![]() ![]() ![]() | 0..1 | time | Closing time of day (ignored if allDay = true) | |
![]() ![]() ![]() | 0..* | BackboneElement | Not available during this time due to provided reason | |
![]() ![]() ![]() ![]() | 1..1 | string | Reason presented to the user explaining why time not available | |
![]() ![]() ![]() ![]() | 0..1 | Period | Service not available from this date | |
![]() ![]() ![]() | 0..1 | string | Description of availability exceptions | |
![]() ![]() ![]() | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |
![]() |
This structure is derived from HealthcareService
Summary
Mandatory: 1 element (3 nested mandatory elements)
Must-Support: 48 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from HealthcareService
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | HealthcareService | The details of a healthcare service available at a location | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() | S | 0..* | (Complex) | Whether the services is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients |
![]() ![]() ![]() | S | 0..* | Identifier | External identifiers for this item |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() | S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() | S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() | S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | S | 1..1 | boolean | Whether this HealthcareService record is in active use |
![]() ![]() ![]() | S | 0..1 | Reference(VhDir Organization) | Organization that provides this service |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Broad category of service being performed or delivered |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Type of service that may be delivered or performed |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Specialties handled by the HealthcareService |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Location) | 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 |
![]() ![]() ![]() | S | 0..1 | markdown | Extra details about the service that can't be placed in the other fields |
![]() ![]() ![]() | S | 0..1 | Attachment | Facilitates quick identification of the service |
![]() ![]() ![]() | S | 0..* | ContactPoint | Contacts related to the healthcare service |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() | S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Location) | Location(s) service is intended for/available to |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Conditions under which service is available/offered |
![]() ![]() ![]() | S | 0..* | BackboneElement | Specific eligibility requirements required to use the service Binding: VhDir Healthcare Service Eligibility (example) |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Coded value for the eligibility |
![]() ![]() ![]() ![]() | S | 0..1 | markdown | Describes the eligibility conditions for the service |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Programs that this service is applicable to |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: VhDir Healthcare Service Characteristic (example) |
![]() ![]() ![]() | S | 0..* | CodeableConcept | The language that this service is offered in |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Ways that the service accepts referrals |
![]() ![]() ![]() | 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 |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | HealthcareService | The details of a healthcare service available at a location | |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: 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 | |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() | S | 0..* | (Complex) | Whether the services is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣ | 0..* | Identifier | External identifiers for this item |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() | ?!SΣ | 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. |
![]() ![]() ![]() ![]() | SΣ | 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 |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use |
![]() ![]() ![]() | SΣ | 0..1 | Reference(VhDir Organization) | Organization that provides this service |
![]() ![]() ![]() | SΣ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. |
![]() ![]() ![]() | SΣ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). |
![]() ![]() ![]() | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. |
![]() ![]() ![]() | SΣ | 0..* | Reference(VhDir Location) | 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 |
![]() ![]() ![]() | S | 0..1 | markdown | Extra details about the service that can't be placed in the other fields |
![]() ![]() ![]() | SΣ | 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 | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Location) | Location(s) service is intended for/available to |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. |
![]() ![]() ![]() | S | 0..* | 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 |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available. |
![]() ![]() ![]() ![]() | S | 0..1 | markdown | Describes the eligibility conditions for the service |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: VhDir Healthcare Service Characteristic (example) |
![]() ![]() ![]() | S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. |
![]() ![]() ![]() | S | 0..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(VhDir Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service |
![]() |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
HealthcareService.language | preferred | CommonLanguages Max Binding: AllLanguages |
HealthcareService.identifier.use | required | IdentifierUse |
HealthcareService.identifier.type | extensible | Identifier Type Codes |
HealthcareService.category | example | ServiceCategory |
HealthcareService.type | example | ServiceType |
HealthcareService.specialty | preferred | PracticeSettingCodeValueSet |
HealthcareService.telecom.system | required | ContactPointSystem |
HealthcareService.telecom.use | required | ContactPointUse |
HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions |
HealthcareService.eligibility.code | example | |
HealthcareService.program | example | Program |
HealthcareService.characteristic | example | VhDirHealthcareServiceCharacteristic |
HealthcareService.communication | preferred | CommonLanguages Max Binding: AllLanguages |
HealthcareService.referralMethod | example | ReferralMethod |
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
GET [base]/HealthcareService?active=[code]
Support: SHALL support search by the active
parameter: http://hl7.org/fhir/SearchParameter/HealthcareService-active
GET [base]/HealthcareService?service-category=[code]
Support: SHALL support search by the service-category
parameter
text
GET [base]/HealthcareService?characteristic=[code]
Support: MAY support search by the characteristic
parameter
text
GET [base]/HealthcareService?coverage-area=[id]
Support: SHOULD support search by the coverage-area
parameter
Location
coverage-area.identifier
, coverage-area.contains
GET [base]/HealthcareService?eligibility=[code]
Support: SHOULD support search by the eligibility
parameter
text
GET [base]/HealthcareService?endpoint=[id]
Support: SHOULD support search by the endpoint
parameter
Endpoint
endpoint.identifier
, endpoint.connection-type
, endpoint.organization
GET [base]/HealthcareService?identifier=[code]
Support: SHALL support search by the identifier
parameter
text
, ofType
GET [base]/HealthcareService?identifier-assigner=[id]
Support: MAY support search by the identifier-assigner
parameter
Organization
below
identifier-assigner.identifier
, identifier-assigner.name
GET [base]/HealthcareService?location=[id]
Support: SHALL support search by the location
parameter
Location
above
, below
location.identifier
, location.type
, location.address
, location.organization
GET [base]/HealthcareService?name=[string]
Support: SHOULD support search by the name
parameter
exact
, contains
GET [base]/HealthcareService?new-patient=[code]
Support: SHOULD support search by the new-patient
parameter
GET [base]/HealthcareService?new-patient-network=[id]
Support: SHOULD support search by the new-patient-network
parameter
Organization
new-patient-network.identifier
, new-patient-network.name
, new-patient-network.partof
GET [base]/HealthcareService?organization=[id]
Support: SHALL support search by the organization
parameter
Organization
above
, below
organization.identifier
, organization.name
, organization.address
, organization.partof
, organization-type
GET [base]/HealthcareService?specialty=[code]
Support: SHOULD support search by the specialty
parameter
text
GET [base]/HealthcareService?service-type=[code]
Support: SHOULD support search by the service-type
parameter
text
GET [base]/HealthcareService?via-intermediary=[id]
Support: MAY support search by the via-intermediary
parameter
PractitionerRole
, Organization
, OrganizationAffiliation
, Location