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

Resource Profile: AS HealthcareService Social Equipment Profile

Official URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-healthcareservice-social-equipment Version: 1.0.0-ballot-2
Active as of 2023-07-18 Computable Name: AsHealthcareServiceSocialEquipmentProfile

Profil créé à partir de HealthcareService dans le contexte de l’Annuaire Santé pour décrire les équipements sociaux représentant les activités des établissements du domaine social et médico-social enregistrés dans FINESS.

Usage:

Formal Views of Profile Content

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

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... meta
.... as-ext-data-trace S0..1(Complex)DataTrace
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace
... as-ext-healthcareservice-authorization-date S0..1dateDate délivrance de l’autorisation de l’activité de soins.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-authorization-date
... as-ext-healthcareservice-implementation-period S0..1PeriodAS HealthcareService Implementation Period Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-implementation-period
... providedBy 0..1Reference(FrOrganization | AS Organization Profile)Référence vers l'id de la structure FINESS ET à laquelle est rattaché cet équipement social (Synonyme : idNat_Struct, identifiantEJ, identifiantEG).
... category S0..*CodeableConceptLa discipline déterminant la nature de l’activité (Synonyme : disciplineEquipementSociale).
... type 0..*CodeableConceptType of service that may be delivered or performed
Binding: https://mos.esante.gouv.fr/NOS/JDV_J136-DisciplineEquipementSocial-RASS/FHIR/JDV-J136-DisciplineEquipementSocial-RASS (required): Liste des disciplines

... eligibility S0..*BackboneElementPopulation prise en charge par l’établissement dans le cadre de l’activité associée à la discipline (Synonyme : clientele, public, patientèle).
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: https://mos.esante.gouv.fr/NOS/JDV_J137-Clientele-RASS/FHIR/JDV-J137-Clientele-RASS (extensible): Liste des populations prises en charge

... characteristic S0..*CodeableConceptLe mode de fonctionnement précisant la modalité d’accueil, d’hébergement et/ou d’ouverture de l’activité associée à la discipline (Synonyme : modeFonctionnement, type d'activité).
Binding: https://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS (extensible): Liste des modes de fonctionnement


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta ΣN0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... as-ext-data-trace S0..1(Complex)DataTrace
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace
.... versionId ΣN0..1idVersion specific identifier
.... lastUpdated ΣN0..1instantWhen the resource version last changed
.... source ΣN0..1uriIdentifies where the resource comes from
.... profile ΣN0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security ΣN0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag ΣN0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!ΣN0..1uriA set of rules under which this content was created
... language N0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text N0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... as-ext-healthcareservice-authorization-date S0..1dateDate délivrance de l’autorisation de l’activité de soins.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-authorization-date
... as-ext-healthcareservice-implementation-period S0..1PeriodAS HealthcareService Implementation Period Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-implementation-period
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier SΣ0..*IdentifierIdentifiant fonctionnel, numéro d'autorisation ARHGOS (Synonyme : numeroAutorisationARHGOS).
... active ?!ΣN0..1booleanWhether this HealthcareService record is in active use
... providedBy ΣC0..1Reference(FrOrganization | AS Organization Profile)Référence vers l'id de la structure FINESS ET à laquelle est rattaché cet équipement social (Synonyme : idNat_Struct, identifiantEJ, identifiantEG).
... category SΣ0..*CodeableConceptLa discipline déterminant la nature de l’activité (Synonyme : disciplineEquipementSociale).
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: https://mos.esante.gouv.fr/NOS/JDV_J136-DisciplineEquipementSocial-RASS/FHIR/JDV-J136-DisciplineEquipementSocial-RASS (required): Liste des disciplines


... specialty ΣN0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location ΣCN0..*Reference(Location)Location(s) where service may be provided
... name ΣN0..1stringDescription of service as presented to a consumer while searching
... comment ΣN0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails N0..1markdownExtra details about the service that can't be placed in the other fields
... photo ΣCN0..1AttachmentFacilitates quick identification of the service
... telecom CN0..*ContactPointContacts related to the healthcare service
... coverageArea CN0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode N0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility S0..*BackboneElementPopulation prise en charge par l’établissement dans le cadre de l’activité associée à la discipline (Synonyme : clientele, public, patientèle).
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: https://mos.esante.gouv.fr/NOS/JDV_J137-Clientele-RASS/FHIR/JDV-J137-Clientele-RASS (extensible): Liste des populations prises en charge

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


... characteristic S0..*CodeableConceptLe mode de fonctionnement précisant la modalité d’accueil, d’hébergement et/ou d’ouverture de l’activité associée à la discipline (Synonyme : modeFonctionnement, type d'activité).
Binding: https://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS (extensible): Liste des modes de fonctionnement


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

Additional BindingsPurpose
AllLanguagesMax Binding

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


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


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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... meta ΣN0..1MetaMetadata about the resource
.... as-ext-data-trace 0..1(Complex)DataTrace
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace
... as-ext-healthcareservice-authorization-date 0..1dateDate délivrance de l’autorisation de l’activité de soins.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-authorization-date
... as-ext-healthcareservice-implementation-period 0..1PeriodAS HealthcareService Implementation Period Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-implementation-period
... category Σ0..*CodeableConceptLa discipline déterminant la nature de l’activité (Synonyme : disciplineEquipementSociale).
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... eligibility 0..*BackboneElementPopulation prise en charge par l’établissement dans le cadre de l’activité associée à la discipline (Synonyme : clientele, public, patientèle).
... characteristic 0..*CodeableConceptLe mode de fonctionnement précisant la modalité d’accueil, d’hébergement et/ou d’ouverture de l’activité associée à la discipline (Synonyme : modeFonctionnement, type d'activité).
Binding: https://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS (extensible): Liste des modes de fonctionnement



doco Documentation for this format

Differential View

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... meta
.... as-ext-data-trace S0..1(Complex)DataTrace
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace
... as-ext-healthcareservice-authorization-date S0..1dateDate délivrance de l’autorisation de l’activité de soins.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-authorization-date
... as-ext-healthcareservice-implementation-period S0..1PeriodAS HealthcareService Implementation Period Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-implementation-period
... providedBy 0..1Reference(FrOrganization | AS Organization Profile)Référence vers l'id de la structure FINESS ET à laquelle est rattaché cet équipement social (Synonyme : idNat_Struct, identifiantEJ, identifiantEG).
... category S0..*CodeableConceptLa discipline déterminant la nature de l’activité (Synonyme : disciplineEquipementSociale).
... type 0..*CodeableConceptType of service that may be delivered or performed
Binding: https://mos.esante.gouv.fr/NOS/JDV_J136-DisciplineEquipementSocial-RASS/FHIR/JDV-J136-DisciplineEquipementSocial-RASS (required): Liste des disciplines

... eligibility S0..*BackboneElementPopulation prise en charge par l’établissement dans le cadre de l’activité associée à la discipline (Synonyme : clientele, public, patientèle).
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: https://mos.esante.gouv.fr/NOS/JDV_J137-Clientele-RASS/FHIR/JDV-J137-Clientele-RASS (extensible): Liste des populations prises en charge

... characteristic S0..*CodeableConceptLe mode de fonctionnement précisant la modalité d’accueil, d’hébergement et/ou d’ouverture de l’activité associée à la discipline (Synonyme : modeFonctionnement, type d'activité).
Binding: https://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS (extensible): Liste des modes de fonctionnement


doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta ΣN0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... as-ext-data-trace S0..1(Complex)DataTrace
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace
.... versionId ΣN0..1idVersion specific identifier
.... lastUpdated ΣN0..1instantWhen the resource version last changed
.... source ΣN0..1uriIdentifies where the resource comes from
.... profile ΣN0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security ΣN0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag ΣN0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!ΣN0..1uriA set of rules under which this content was created
... language N0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text N0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... as-ext-healthcareservice-authorization-date S0..1dateDate délivrance de l’autorisation de l’activité de soins.
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-authorization-date
... as-ext-healthcareservice-implementation-period S0..1PeriodAS HealthcareService Implementation Period Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-implementation-period
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier SΣ0..*IdentifierIdentifiant fonctionnel, numéro d'autorisation ARHGOS (Synonyme : numeroAutorisationARHGOS).
... active ?!ΣN0..1booleanWhether this HealthcareService record is in active use
... providedBy ΣC0..1Reference(FrOrganization | AS Organization Profile)Référence vers l'id de la structure FINESS ET à laquelle est rattaché cet équipement social (Synonyme : idNat_Struct, identifiantEJ, identifiantEG).
... category SΣ0..*CodeableConceptLa discipline déterminant la nature de l’activité (Synonyme : disciplineEquipementSociale).
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: https://mos.esante.gouv.fr/NOS/JDV_J136-DisciplineEquipementSocial-RASS/FHIR/JDV-J136-DisciplineEquipementSocial-RASS (required): Liste des disciplines


... specialty ΣN0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location ΣCN0..*Reference(Location)Location(s) where service may be provided
... name ΣN0..1stringDescription of service as presented to a consumer while searching
... comment ΣN0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails N0..1markdownExtra details about the service that can't be placed in the other fields
... photo ΣCN0..1AttachmentFacilitates quick identification of the service
... telecom CN0..*ContactPointContacts related to the healthcare service
... coverageArea CN0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode N0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility S0..*BackboneElementPopulation prise en charge par l’établissement dans le cadre de l’activité associée à la discipline (Synonyme : clientele, public, patientèle).
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: https://mos.esante.gouv.fr/NOS/JDV_J137-Clientele-RASS/FHIR/JDV-J137-Clientele-RASS (extensible): Liste des populations prises en charge

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


... characteristic S0..*CodeableConceptLe mode de fonctionnement précisant la modalité d’accueil, d’hébergement et/ou d’ouverture de l’activité associée à la discipline (Synonyme : modeFonctionnement, type d'activité).
Binding: https://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS (extensible): Liste des modes de fonctionnement


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

Additional BindingsPurpose
AllLanguagesMax Binding

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


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


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

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
HealthcareService.meta.securityextensibleAll Security Labels
HealthcareService.meta.tagexampleCommonTags
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.categoryexampleServiceCategory
HealthcareService.typerequiredhttps://mos.esante.gouv.fr/NOS/JDV_J136-DisciplineEquipementSocial-RASS/FHIR/JDV-J136-DisciplineEquipementSocial-RASS
HealthcareService.specialtypreferredPracticeSettingCodeValueSet
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibility.codeextensiblehttps://mos.esante.gouv.fr/NOS/JDV_J137-Clientele-RASS/FHIR/JDV-J137-Clientele-RASS
HealthcareService.programexampleProgram
HealthcareService.characteristicextensiblehttps://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
att-1errorHealthcareService.photoIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
cpt-2errorHealthcareService.telecomA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorHealthcareService.notAvailable.duringIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorHealthcareService.providedBy, HealthcareService.location, HealthcareService.coverageArea, HealthcareService.endpointSHALL 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'))