Guide d'implémentation Fr Core
2.1.0 - trial-use
This page is part of the Guide d'implémentation Fr Core (v2.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-healthcare-service | Version: 2.1.0 | |||
Active as of 2024-09-04 | Computable Name: FRCoreHealthcareServiceProfile |
Profile of the HealthcareService resource for France. This profile adds the element serviceTypeDuration to associate the service with the duration of this service.
Profil de la ressource HealthcareService pour l’usage en France. Ce profil ajoute l’élément serviceTypeDuration de façon à associer le service avec la durée du service.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from HealthcareService
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | HealthcareService | |||
meta | ||||
Slices for profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
profile:fr-canonical | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-healthcare-service | |
Slices for extension | Content/Rules for all slices | |||
serviceTypeDuration | 0..* | (Complex) | FR Core Service Type Duration Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-service-type-duration | |
identifier | ||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
providedBy | 0..1 | Reference(FR Core Organization Profile) | Organization that provides this service | |
category | 0..1 | CodeableConcept | Broad category of service being performed or delivered | |
specialty | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: FR Core ValueSet Practitioner specialty (preferred) | |
location | 0..* | Reference(FR Core Location Profile) | Location(s) where service may be provided | |
telecom | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
coverageArea | 0..* | Reference(FR Core Location Profile) | Location(s) service is intended for/available to | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HealthcareService.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard | |
HealthcareService.specialty | preferred | FRCoreValueSetPractitionerSpecialtyhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
serviceTypeDuration | 0..* | (Complex) | FR Core Service Type Duration Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-service-type-duration | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
providedBy | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization that provides this service |
category | Σ | 0..1 | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. |
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: FR Core ValueSet Practitioner specialty (preferred) |
location | Σ | 0..* | Reference(FR Core Location Profile) | Location(s) where service may be provided |
telecom | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. |
coverageArea | 0..* | Reference(FR Core Location Profile) | Location(s) service is intended for/available to | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | |
HealthcareService.specialty | preferred | FRCoreValueSetPractitionerSpecialtyhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | HealthcareService.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
HealthcareService | 0..* | HealthcareService | 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 | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-healthcare-service | ||||
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 | |||||
serviceTypeDuration | 0..* | (Complex) | FR Core Service Type Duration Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-service-type-duration | |||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
type | Σ | 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 | Σ | 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(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
providedBy | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization that provides this service | ||||
category | Σ | 0..1 | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
type | Σ | 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). | ||||
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: FR Core ValueSet Practitioner specialty (preferred) | ||||
location | Σ | 0..* | Reference(FR Core Location Profile) | Location(s) where service may be provided | ||||
name | Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
comment | Σ | 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 | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. | ||||
coverageArea | 0..* | Reference(FR Core Location Profile) | Location(s) service is intended for/available to | |||||
serviceProvisionCode | 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. | |||||
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 Description (No ValueSet): (example): Coded values underwhich a specific service is made available. | |||||
comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
program | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description (No ValueSet): (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
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: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. | |||||
appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |||||
availableTime | 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 | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
notAvailable | 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 | 1..1 | string | Reason presented to the user explaining why time not available | |||||
during | 0..1 | Period | Service not available from this date | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
HealthcareService.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
HealthcareService.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
HealthcareService.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
HealthcareService.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard | ||||
HealthcareService.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
HealthcareService.type | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
HealthcareService.specialty | preferred | FRCoreValueSetPractitionerSpecialtyhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG | ||||
HealthcareService.serviceProvisionCode | example | ServiceProvisionConditionshttp://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard | ||||
HealthcareService.eligibility.code | example | |||||
HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/program from the FHIR Standard | ||||
HealthcareService.characteristic | example | |||||
HealthcareService.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard | ||||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | HealthcareService.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from HealthcareService
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from HealthcareService
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | HealthcareService | |||
meta | ||||
Slices for profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
profile:fr-canonical | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-healthcare-service | |
Slices for extension | Content/Rules for all slices | |||
serviceTypeDuration | 0..* | (Complex) | FR Core Service Type Duration Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-service-type-duration | |
identifier | ||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
providedBy | 0..1 | Reference(FR Core Organization Profile) | Organization that provides this service | |
category | 0..1 | CodeableConcept | Broad category of service being performed or delivered | |
specialty | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: FR Core ValueSet Practitioner specialty (preferred) | |
location | 0..* | Reference(FR Core Location Profile) | Location(s) where service may be provided | |
telecom | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
coverageArea | 0..* | Reference(FR Core Location Profile) | Location(s) service is intended for/available to | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HealthcareService.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard | |
HealthcareService.specialty | preferred | FRCoreValueSetPractitionerSpecialtyhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
serviceTypeDuration | 0..* | (Complex) | FR Core Service Type Duration Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-service-type-duration | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
providedBy | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization that provides this service |
category | Σ | 0..1 | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. |
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: FR Core ValueSet Practitioner specialty (preferred) |
location | Σ | 0..* | Reference(FR Core Location Profile) | Location(s) where service may be provided |
telecom | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. |
coverageArea | 0..* | Reference(FR Core Location Profile) | Location(s) service is intended for/available to | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | |
HealthcareService.specialty | preferred | FRCoreValueSetPractitionerSpecialtyhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | HealthcareService.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
HealthcareService | 0..* | HealthcareService | 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 | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-healthcare-service | ||||
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 | |||||
serviceTypeDuration | 0..* | (Complex) | FR Core Service Type Duration Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-service-type-duration | |||||
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
type | Σ | 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 | Σ | 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(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
providedBy | Σ | 0..1 | Reference(FR Core Organization Profile) | Organization that provides this service | ||||
category | Σ | 0..1 | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
type | Σ | 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). | ||||
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: FR Core ValueSet Practitioner specialty (preferred) | ||||
location | Σ | 0..* | Reference(FR Core Location Profile) | Location(s) where service may be provided | ||||
name | Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
comment | Σ | 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 | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. | ||||
coverageArea | 0..* | Reference(FR Core Location Profile) | Location(s) service is intended for/available to | |||||
serviceProvisionCode | 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. | |||||
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 Description (No ValueSet): (example): Coded values underwhich a specific service is made available. | |||||
comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
program | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description (No ValueSet): (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
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: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. | |||||
appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |||||
availableTime | 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 | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |||||
availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |||||
availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |||||
notAvailable | 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 | 1..1 | string | Reason presented to the user explaining why time not available | |||||
during | 0..1 | Period | Service not available from this date | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
HealthcareService.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
HealthcareService.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
HealthcareService.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
HealthcareService.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard | ||||
HealthcareService.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
HealthcareService.type | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
HealthcareService.specialty | preferred | FRCoreValueSetPractitionerSpecialtyhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-practitioner-specialty from this IG | ||||
HealthcareService.serviceProvisionCode | example | ServiceProvisionConditionshttp://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard | ||||
HealthcareService.eligibility.code | example | |||||
HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/program from the FHIR Standard | ||||
HealthcareService.characteristic | example | |||||
HealthcareService.communication | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard | ||||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | HealthcareService.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from HealthcareService
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron