Annuaire Santé
1.0.0-ballot-2 - STU1
This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v1.0.0-ballot-2: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
Active as of 2023-07-18 |
Definitions for the as-healthcareservice-healthcare-activity resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. HealthcareService | |||||
Definition | The details of a healthcare service available at a location. | ||||
Control | 0..* | ||||
2. HealthcareService.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Summary | true | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
3. HealthcareService.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Meta | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
4. HealthcareService.meta.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
5. HealthcareService.meta.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension | ||||
Standards Status | Normative (from Trial Use) | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on HealthcareService.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
6. HealthcareService.meta.extension:as-ext-data-trace | |||||
SliceName | as-ext-data-trace | ||||
Definition | Informe sur l'origine de la donnée (Autorité d'Enregistrement (AE) et Système d'Information (SI)).. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AsDataTraceExtension) (Complex Extension) | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
7. HealthcareService.meta.versionId | |||||
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | id | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
8. HealthcareService.meta.lastUpdated | |||||
Definition | When the resource last changed - e.g. when the version changed. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | instant | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
9. HealthcareService.meta.source | |||||
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | uri | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
10. HealthcareService.meta.profile | |||||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | canonical(StructureDefinition) | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
11. HealthcareService.meta.security | |||||
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Binding | The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System | ||||
Type | Coding | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
12. HealthcareService.meta.tag | |||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Binding | For example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
Type | Coding | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
13. HealthcareService.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
14. HealthcareService.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | code | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
15. HealthcareService.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Narrative | ||||
Standards Status | Normative (from Trial Use) | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
16. HealthcareService.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
17. HealthcareService.extension | |||||
Definition | An Extension | ||||
Control | 1..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on HealthcareService.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
18. HealthcareService.extension:as-ext-healthcareservice-activity-type | |||||
SliceName | as-ext-healthcareservice-activity-type | ||||
Definition | Extension créée dans le cadre de l'Annuaire Santé pour décrire les types d’activités sanitaires des établissements FINESS. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AsHealthcareServiceActivityTypeExtension) (Extension Type: CodeableConcept) | ||||
Must Support | true | ||||
Comments | Synonyme : activite la liste des activités de soins soumises à autorisation est fixée par décret en Conseil d'Etat (article L.6122-25 du CSP). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
19. HealthcareService.extension:as-ext-healthcareservice-authorization-date | |||||
SliceName | as-ext-healthcareservice-authorization-date | ||||
Definition | Extension créée dans le cadre de l'Annuaire Santé pour prise en compte de la date délivrance de l’autorisation de l’activité de soins. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AsHealthcareServiceAuthorizationDateExtension) (Extension Type: date) | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
20. HealthcareService.extension:as-ext-healthcareservice-authorization-number-arhgos | |||||
SliceName | as-ext-healthcareservice-authorization-number-arhgos | ||||
Definition | Extension créée dans le cadre de l'Annuaire Santé pour prise en compte du numéro d'autorisation ARHGOS. | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AsHealthcareServiceAuthorizationNumberARHGOSExtension) (Extension Type: string) | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
21. HealthcareService.extension:as-ext-healthcareservice-implementation-period | |||||
SliceName | as-ext-healthcareservice-implementation-period | ||||
Definition | Extension créée dans le cadre de l'Annuaire Santé pour en compte de la date d'échéance de l'autorisation de l'activité de soins. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AsHealthcareServiceImplementationPeriodExtension) (Extension Type: Period) | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
22. HealthcareService.extension:as-ext-healthcareservice-delete-autorization-implantation | |||||
SliceName | as-ext-healthcareservice-delete-autorization-implantation | ||||
Definition | Extension créée dans le cadre de l'Annuaire Santé pour en compte de l'indicateur de suppression de l'autorisation de l'activité de soins. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AsHealthcareServiceDeleteAutorizationImplantationExtension) (Extension Type: boolean) | ||||
Must Support | true | ||||
Comments | Synonyme : suppressionAutorisation ; donnée propre à FINESS | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
23. HealthcareService.extension:as-ext-healthcareservice-date-update-activity | |||||
SliceName | as-ext-healthcareservice-date-update-activity | ||||
Definition | Extension créée dans le cadre de l'Annuaire Santé pour prise en compte de la date de mise à jour des données de l'activité de soins. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AsHealthcareServiceDateUpdateActivityExtension) (Extension Type: date) | ||||
Must Support | true | ||||
Comments | Synonyme : dateMajAutorisation | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
24. HealthcareService.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Standards Status | Normative (from Trial Use) | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on HealthcareService.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
25. HealthcareService.identifier | |||||
Definition | External identifiers for this item. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Identifier | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
26. HealthcareService.active | |||||
Definition | This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | boolean | ||||
Is Modifier | true | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. | ||||
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. HealthcareService.providedBy | |||||
Definition | The organization that provides this healthcare service. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Reference(FrOrganization|AsOrganizationProfile) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
Comments | This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
28. HealthcareService.category | |||||
Definition | Identifies the broad category of service being performed or delivered. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Binding | The codes SHALL be taken from https://mos.esante.gouv.fr/NOS/JDV_J132-ModaliteActivite-RASS/FHIR/JDV-J132-ModaliteActivite-RASS Liste des modalité | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
Alternate Names | service category | ||||
Comments | Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
29. HealthcareService.type | |||||
Definition | The specific type of service that may be delivered or performed. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Binding | The codes SHALL be taken from https://mos.esante.gouv.fr/NOS/JDV_J133-ActiviteSanitaireRegulee-RASS/FHIR/JDV-J133-ActiviteSanitaireRegulee-RASS Liste des activités sanitaire | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Alternate Names | service type | ||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
30. HealthcareService.specialty | |||||
Definition | Collection of specialties handled by the service site. This is more of a medical term. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet A specialty that a healthcare service may provide | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
31. HealthcareService.location | |||||
Definition | The location(s) where this healthcare service may be provided. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Reference(Location) | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
32. HealthcareService.name | |||||
Definition | Further description of the service as it would be presented to a consumer while searching. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | string | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
33. HealthcareService.comment | |||||
Definition | Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | string | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
34. HealthcareService.extraDetails | |||||
Definition | Extra details about the service that can't be placed in the other fields. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | markdown | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
35. HealthcareService.photo | |||||
Definition | If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Attachment | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". | ||||
Invariants | Defined on this element att-1: If the Attachment has data, it SHALL have a contentType (: data.empty() or contentType.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
36. HealthcareService.telecom | |||||
Definition | List of contacts related to this specific healthcare service. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | ContactPoint | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | If this is empty, then refer to the location's contacts. | ||||
Invariants | Defined on this element cpt-2: A system is required if a value is provided. (: value.empty() or system.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
37. HealthcareService.coverageArea | |||||
Definition | The location(s) that this service is available to (not where the service is provided). | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Reference(Location) | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home". | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
38. HealthcareService.serviceProvisionCode | |||||
Definition | The code(s) that detail the conditions under which the healthcare service is available/offered. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Binding | For example codes, see ServiceProvisionConditions The code(s) that detail the conditions under which the healthcare service is available/offered | ||||
Type | CodeableConcept | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
39. HealthcareService.eligibility | |||||
Definition | Does this service have specific eligibility requirements that need to be met in order to use the service? | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | BackboneElement | ||||
Standards Status | Normative (from Trial Use) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
40. HealthcareService.eligibility.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
41. HealthcareService.eligibility.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension | ||||
Standards Status | Normative (from Trial Use) | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on HealthcareService.eligibility.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
42. HealthcareService.eligibility.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
43. HealthcareService.eligibility.code | |||||
Definition | Coded value for the eligibility. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Binding | Coded values underwhich a specific service is made available. | ||||
Type | CodeableConcept | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
44. HealthcareService.eligibility.comment | |||||
Definition | Describes the eligibility conditions for the service. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | markdown | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
45. HealthcareService.program | |||||
Definition | Programs that this service is applicable to. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Binding | For example codes, see Program Government or local programs that this service applies to | ||||
Type | CodeableConcept | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
46. HealthcareService.characteristic | |||||
Definition | Collection of characteristics (attributes). | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Binding | The codes SHALL be taken from https://mos.esante.gouv.fr/NOS/JDV_J134-FormeActivite-RASS/FHIR/JDV-J134-FormeActivite-RASS Liste des formes d'activit | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Comments | These could be such things as is wheelchair accessible. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
47. HealthcareService.communication | |||||
Definition | Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | CodeableConcept | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
48. HealthcareService.referralMethod | |||||
Definition | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Binding | For example codes, see ReferralMethod The methods of referral can be used when referring to a specific HealthCareService resource | ||||
Type | CodeableConcept | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
49. HealthcareService.appointmentRequired | |||||
Definition | Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | boolean | ||||
Standards Status | Normative (from Trial Use) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
50. HealthcareService.availableTime | |||||
Definition | A collection of times that the Service Site is available. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | BackboneElement | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | More detailed availability information may be provided in associated Schedule/Slot resources. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
51. HealthcareService.availableTime.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
52. HealthcareService.availableTime.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension | ||||
Standards Status | Normative (from Trial Use) | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on HealthcareService.availableTime.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
53. HealthcareService.availableTime.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
54. HealthcareService.availableTime.daysOfWeek | |||||
Definition | Indicates which days of the week are available between the start and end Times. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Binding | The codes SHALL be taken from DaysOfWeek The days of the week | ||||
Type | code | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
55. HealthcareService.availableTime.allDay | |||||
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | boolean | ||||
Standards Status | Normative (from Trial Use) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
56. HealthcareService.availableTime.availableStartTime | |||||
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | time | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | The time zone is expected to be for where this HealthcareService is provided at. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
57. HealthcareService.availableTime.availableEndTime | |||||
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | time | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | The time zone is expected to be for where this HealthcareService is provided at. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
58. HealthcareService.notAvailable | |||||
Definition | The HealthcareService is not available during this period of time due to the provided reason. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | BackboneElement | ||||
Standards Status | Normative (from Trial Use) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
59. HealthcareService.notAvailable.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
60. HealthcareService.notAvailable.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension | ||||
Standards Status | Normative (from Trial Use) | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on HealthcareService.notAvailable.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
61. HealthcareService.notAvailable.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Standards Status | Normative (from Trial Use) | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
62. HealthcareService.notAvailable.description | |||||
Definition | The reason that can be presented to the user as to why this time is not available. | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | string | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
63. HealthcareService.notAvailable.during | |||||
Definition | Service is not available (seasonally or for a public holiday) from this date. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Period | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) per-1: If present, start SHALL have a lower value than end (: start.hasValue().not() or end.hasValue().not() or (start <= end)) | ||||
64. HealthcareService.availabilityExceptions | |||||
Definition | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | string | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
65. HealthcareService.endpoint | |||||
Definition | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Reference(Endpoint) | ||||
Standards Status | Normative (from Trial Use) | ||||
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided (: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |