Annuaire Santé
1.0.0-ballot-4 - trial-use France flag

This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v1.0.0-ballot-4: 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-4
Active as of 2024-04-02 Computable Name: AsHealthcareServiceSocialEquipmentProfile

Profil générique 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 : Informe sur l'origine de la donnée (Autorité d'Enregistrement (AE) et Système d'Information (SI).
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace
... as-ext-healthcareservice-authorization S0..*(Complex)AS HealthcareService Autorization Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-authorization
... as-ext-patient-type S0..*(Complex)AS Patient Type Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-patient-type
... Slices for identifier S0..*IdentifierExternal identifiers for this item
Slice: Unordered, Open by pattern:system
.... identifier:numAutorisationArhgos 0..1IdentifierIdentifiant fonctionnel, numéro d'autorisation ARHGOS (numeroAutorisationARHGOS).
..... system 1..1uriThe namespace for the identifier value
Required Pattern: https://arhgos.ars.sante.fr/
... providedBy 0..1Reference(FrOrganization | AS Organization Profile)Référence vers l'id de la structure FINESS ET à laquelle est rattaché cet équipement social (idNat_Struct, identifiantEJ, identifiantEG).
... type S0..*CodeableConceptLa discipline déterminant la nature de l’activité (disciplineEquipementSociale).
Binding: JDV_J136-DisciplineEquipementSocial-RASS (required)
... eligibility S0..*BackboneElementPopulation prise en charge par l’établissement dans le cadre de l’activité associée à la discipline (clientele, public, patientele).
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: JDV_J137-Clientele-RASS (extensible)
... 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 (modeFonctionnement, typeActivite).
Binding: JDV_J138-TypeActivite-RASS (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
HealthcareService.typerequiredJDV_J136-DisciplineEquipementSocial-RASS
https://mos.esante.gouv.fr/NOS/JDV_J136-DisciplineEquipementSocial-RASS/FHIR/JDV-J136-DisciplineEquipementSocial-RASS
HealthcareService.eligibility.codeextensibleJDV_J137-Clientele-RASS
https://mos.esante.gouv.fr/NOS/JDV_J137-Clientele-RASS/FHIR/JDV-J137-Clientele-RASS
HealthcareService.characteristicextensibleJDV_J138-TypeActivite-RASS
https://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... meta Σ0..1MetaMetadata about the resource
.... as-ext-data-trace S0..1(Complex)DataTrace : Informe sur l'origine de la donnée (Autorité d'Enregistrement (AE) et Système d'Information (SI).
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... as-ext-healthcareservice-authorization S0..*(Complex)AS HealthcareService Autorization Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-authorization
... as-ext-supported-capacity S0..*(Complex)AS Supported Capacity Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-supported-capacity
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ0..*IdentifierExternal identifiers for this item
Slice: Unordered, Open by pattern:system
.... identifier:numAutorisationArhgos Σ0..1IdentifierIdentifiant fonctionnel, numéro d'autorisation ARHGOS (numeroAutorisationARHGOS).
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: https://arhgos.ars.sante.fr/
... active ?!Σ0..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 (idNat_Struct, identifiantEJ, identifiantEG).
ref-1: SHALL have a contained resource if a local reference is provided
... type SΣ0..*CodeableConceptLa discipline déterminant la nature de l’activité (disciplineEquipementSociale).
Binding: JDV_J136-DisciplineEquipementSocial-RASS (required)
... eligibility S0..*BackboneElementPopulation prise en charge par l’établissement dans le cadre de l’activité associée à la discipline (clientele, public, patientele).
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: JDV_J137-Clientele-RASS (extensible)
... 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 (modeFonctionnement, typeActivite).
Binding: JDV_J138-TypeActivite-RASS (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.identifier:numAutorisationArhgos.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
HealthcareService.typerequiredJDV_J136-DisciplineEquipementSocial-RASS
https://mos.esante.gouv.fr/NOS/JDV_J136-DisciplineEquipementSocial-RASS/FHIR/JDV-J136-DisciplineEquipementSocial-RASS
HealthcareService.eligibility.codeextensibleJDV_J137-Clientele-RASS
https://mos.esante.gouv.fr/NOS/JDV_J137-Clientele-RASS/FHIR/JDV-J137-Clientele-RASS
HealthcareService.characteristicextensibleJDV_J138-TypeActivite-RASS
https://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorHealthcareServiceIf 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-4errorHealthcareServiceIf 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-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceHealthcareServiceA resource should have narrative for robust management
: text.`div`.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()
ref-1errorHealthcareService.providedBySHALL 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'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta Σ0..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 : Informe sur l'origine de la donnée (Autorité d'Enregistrement (AE) et Système d'Information (SI).
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*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 ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..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 S0..*(Complex)AS HealthcareService Autorization Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-authorization
... as-ext-patient-type S0..*(Complex)AS Patient Type Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-patient-type
... as-ext-supported-capacity S0..*(Complex)AS Supported Capacity Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-supported-capacity
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ0..*IdentifierExternal identifiers for this item
Slice: Unordered, Open by pattern:system
.... identifier:numAutorisationArhgos Σ0..1IdentifierIdentifiant fonctionnel, numéro d'autorisation ARHGOS (numeroAutorisationARHGOS).
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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 Σ1..1uriThe namespace for the identifier value
Required Pattern: https://arhgos.ars.sante.fr/
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period ΣC0..1PeriodTime period when id is/was valid for use
per-1: If present, start SHALL have a lower value than end
..... assigner ΣC0..1Reference(Organization)Organization that issued id (may be just text)
ref-1: SHALL have a contained resource if a local reference is provided
... active ?!Σ0..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 (idNat_Struct, identifiantEJ, identifiantEG).
ref-1: SHALL have a contained resource if a local reference is provided
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type SΣ0..*CodeableConceptLa discipline déterminant la nature de l’activité (disciplineEquipementSociale).
Binding: JDV_J136-DisciplineEquipementSocial-RASS (required)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location ΣC0..*Reference(Location)Location(s) where service may be provided
ref-1: SHALL have a contained resource if a local reference is provided
... name Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo ΣC0..1AttachmentFacilitates quick identification of the service
att-1: If the Attachment has data, it SHALL have a contentType
... telecom C0..*ContactPointContacts related to the healthcare service
cpt-2: A system is required if a value is provided.
... coverageArea C0..*Reference(Location)Location(s) service is intended for/available to
ref-1: SHALL have a contained resource if a local reference is provided
... serviceProvisionCode 0..*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 (clientele, public, patientele).
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: JDV_J137-Clientele-RASS (extensible)
.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*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 (modeFonctionnement, typeActivite).
Binding: JDV_J138-TypeActivite-RASS (extensible)
... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

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


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*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 ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*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 ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during C0..1PeriodService not available from this date
per-1: If present, start SHALL have a lower value than end
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint C0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
HealthcareService.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
HealthcareService.identifier:numAutorisationArhgos.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
HealthcareService.identifier:numAutorisationArhgos.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
HealthcareService.categoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typerequiredJDV_J136-DisciplineEquipementSocial-RASS
https://mos.esante.gouv.fr/NOS/JDV_J136-DisciplineEquipementSocial-RASS/FHIR/JDV-J136-DisciplineEquipementSocial-RASS
HealthcareService.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
http://hl7.org/fhir/ValueSet/service-provision-conditions
from the FHIR Standard
HealthcareService.eligibility.codeextensibleJDV_J137-Clientele-RASS
https://mos.esante.gouv.fr/NOS/JDV_J137-Clientele-RASS/FHIR/JDV-J137-Clientele-RASS
HealthcareService.programexampleProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.characteristicextensibleJDV_J138-TypeActivite-RASS
https://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
HealthcareService.referralMethodexampleReferralMethod
http://hl7.org/fhir/ValueSet/service-referral-method
from the FHIR Standard
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

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()
dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorHealthcareServiceIf 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-4errorHealthcareServiceIf 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-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceHealthcareServiceA resource should have narrative for robust management
: text.`div`.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.identifier:numAutorisationArhgos.period, HealthcareService.notAvailable.duringIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorHealthcareService.identifier:numAutorisationArhgos.assigner, HealthcareService.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'))

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 : Informe sur l'origine de la donnée (Autorité d'Enregistrement (AE) et Système d'Information (SI).
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace
... as-ext-healthcareservice-authorization S0..*(Complex)AS HealthcareService Autorization Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-authorization
... as-ext-patient-type S0..*(Complex)AS Patient Type Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-patient-type
... Slices for identifier S0..*IdentifierExternal identifiers for this item
Slice: Unordered, Open by pattern:system
.... identifier:numAutorisationArhgos 0..1IdentifierIdentifiant fonctionnel, numéro d'autorisation ARHGOS (numeroAutorisationARHGOS).
..... system 1..1uriThe namespace for the identifier value
Required Pattern: https://arhgos.ars.sante.fr/
... providedBy 0..1Reference(FrOrganization | AS Organization Profile)Référence vers l'id de la structure FINESS ET à laquelle est rattaché cet équipement social (idNat_Struct, identifiantEJ, identifiantEG).
... type S0..*CodeableConceptLa discipline déterminant la nature de l’activité (disciplineEquipementSociale).
Binding: JDV_J136-DisciplineEquipementSocial-RASS (required)
... eligibility S0..*BackboneElementPopulation prise en charge par l’établissement dans le cadre de l’activité associée à la discipline (clientele, public, patientele).
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: JDV_J137-Clientele-RASS (extensible)
... 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 (modeFonctionnement, typeActivite).
Binding: JDV_J138-TypeActivite-RASS (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
HealthcareService.typerequiredJDV_J136-DisciplineEquipementSocial-RASS
https://mos.esante.gouv.fr/NOS/JDV_J136-DisciplineEquipementSocial-RASS/FHIR/JDV-J136-DisciplineEquipementSocial-RASS
HealthcareService.eligibility.codeextensibleJDV_J137-Clientele-RASS
https://mos.esante.gouv.fr/NOS/JDV_J137-Clientele-RASS/FHIR/JDV-J137-Clientele-RASS
HealthcareService.characteristicextensibleJDV_J138-TypeActivite-RASS
https://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... meta Σ0..1MetaMetadata about the resource
.... as-ext-data-trace S0..1(Complex)DataTrace : Informe sur l'origine de la donnée (Autorité d'Enregistrement (AE) et Système d'Information (SI).
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... as-ext-healthcareservice-authorization S0..*(Complex)AS HealthcareService Autorization Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-authorization
... as-ext-supported-capacity S0..*(Complex)AS Supported Capacity Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-supported-capacity
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ0..*IdentifierExternal identifiers for this item
Slice: Unordered, Open by pattern:system
.... identifier:numAutorisationArhgos Σ0..1IdentifierIdentifiant fonctionnel, numéro d'autorisation ARHGOS (numeroAutorisationARHGOS).
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: https://arhgos.ars.sante.fr/
... active ?!Σ0..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 (idNat_Struct, identifiantEJ, identifiantEG).
ref-1: SHALL have a contained resource if a local reference is provided
... type SΣ0..*CodeableConceptLa discipline déterminant la nature de l’activité (disciplineEquipementSociale).
Binding: JDV_J136-DisciplineEquipementSocial-RASS (required)
... eligibility S0..*BackboneElementPopulation prise en charge par l’établissement dans le cadre de l’activité associée à la discipline (clientele, public, patientele).
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: JDV_J137-Clientele-RASS (extensible)
... 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 (modeFonctionnement, typeActivite).
Binding: JDV_J138-TypeActivite-RASS (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.identifier:numAutorisationArhgos.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
HealthcareService.typerequiredJDV_J136-DisciplineEquipementSocial-RASS
https://mos.esante.gouv.fr/NOS/JDV_J136-DisciplineEquipementSocial-RASS/FHIR/JDV-J136-DisciplineEquipementSocial-RASS
HealthcareService.eligibility.codeextensibleJDV_J137-Clientele-RASS
https://mos.esante.gouv.fr/NOS/JDV_J137-Clientele-RASS/FHIR/JDV-J137-Clientele-RASS
HealthcareService.characteristicextensibleJDV_J138-TypeActivite-RASS
https://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorHealthcareServiceIf 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-4errorHealthcareServiceIf 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-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceHealthcareServiceA resource should have narrative for robust management
: text.`div`.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()
ref-1errorHealthcareService.providedBySHALL 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'))

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 Σ0..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 : Informe sur l'origine de la donnée (Autorité d'Enregistrement (AE) et Système d'Information (SI).
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-data-trace
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*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 ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..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 S0..*(Complex)AS HealthcareService Autorization Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-healthcareservice-authorization
... as-ext-patient-type S0..*(Complex)AS Patient Type Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-patient-type
... as-ext-supported-capacity S0..*(Complex)AS Supported Capacity Extension
URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-ext-supported-capacity
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ0..*IdentifierExternal identifiers for this item
Slice: Unordered, Open by pattern:system
.... identifier:numAutorisationArhgos Σ0..1IdentifierIdentifiant fonctionnel, numéro d'autorisation ARHGOS (numeroAutorisationARHGOS).
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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 Σ1..1uriThe namespace for the identifier value
Required Pattern: https://arhgos.ars.sante.fr/
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period ΣC0..1PeriodTime period when id is/was valid for use
per-1: If present, start SHALL have a lower value than end
..... assigner ΣC0..1Reference(Organization)Organization that issued id (may be just text)
ref-1: SHALL have a contained resource if a local reference is provided
... active ?!Σ0..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 (idNat_Struct, identifiantEJ, identifiantEG).
ref-1: SHALL have a contained resource if a local reference is provided
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type SΣ0..*CodeableConceptLa discipline déterminant la nature de l’activité (disciplineEquipementSociale).
Binding: JDV_J136-DisciplineEquipementSocial-RASS (required)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location ΣC0..*Reference(Location)Location(s) where service may be provided
ref-1: SHALL have a contained resource if a local reference is provided
... name Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo ΣC0..1AttachmentFacilitates quick identification of the service
att-1: If the Attachment has data, it SHALL have a contentType
... telecom C0..*ContactPointContacts related to the healthcare service
cpt-2: A system is required if a value is provided.
... coverageArea C0..*Reference(Location)Location(s) service is intended for/available to
ref-1: SHALL have a contained resource if a local reference is provided
... serviceProvisionCode 0..*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 (clientele, public, patientele).
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: JDV_J137-Clientele-RASS (extensible)
.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*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 (modeFonctionnement, typeActivite).
Binding: JDV_J138-TypeActivite-RASS (extensible)
... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

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


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*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 ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*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 ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during C0..1PeriodService not available from this date
per-1: If present, start SHALL have a lower value than end
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint C0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
HealthcareService.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
HealthcareService.identifier:numAutorisationArhgos.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
HealthcareService.identifier:numAutorisationArhgos.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
HealthcareService.categoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typerequiredJDV_J136-DisciplineEquipementSocial-RASS
https://mos.esante.gouv.fr/NOS/JDV_J136-DisciplineEquipementSocial-RASS/FHIR/JDV-J136-DisciplineEquipementSocial-RASS
HealthcareService.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
http://hl7.org/fhir/ValueSet/service-provision-conditions
from the FHIR Standard
HealthcareService.eligibility.codeextensibleJDV_J137-Clientele-RASS
https://mos.esante.gouv.fr/NOS/JDV_J137-Clientele-RASS/FHIR/JDV-J137-Clientele-RASS
HealthcareService.programexampleProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.characteristicextensibleJDV_J138-TypeActivite-RASS
https://mos.esante.gouv.fr/NOS/JDV_J138-TypeActivite-RASS/FHIR/JDV-J138-TypeActivite-RASS
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
HealthcareService.referralMethodexampleReferralMethod
http://hl7.org/fhir/ValueSet/service-referral-method
from the FHIR Standard
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

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()
dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorHealthcareServiceIf 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-4errorHealthcareServiceIf 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-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceHealthcareServiceA resource should have narrative for robust management
: text.`div`.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.identifier:numAutorisationArhgos.period, HealthcareService.notAvailable.duringIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorHealthcareService.identifier:numAutorisationArhgos.assigner, HealthcareService.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'))

 

Other representations of profile: CSV, Excel, Schematron