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

This page is part of the Guide d'implémentation FHIR - Annuaire de santé (v1.0.0-ballot-3: 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 Donnée Publique HealthcareService Healthcare Activity Profile

Official URL: https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-dp-healthcareservice-healthcare-activity Version: 1.0.0-ballot-3
Active as of 2023-12-19 Computable Name: AsDpHealthcareServiceHealthcareActivityProfile

Profil public applicatif créé à partir du profil générique as-healthcareservice-healthcare-activity dans le contexte des données en accès libre de l’Annuaire Santé.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from AsHealthcareServiceHealthcareActivityProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AsHealthcareServiceHealthcareActivityProfileThe details of a healthcare service available at a location
... active 1..1booleanWhether this HealthcareService record is in active use
... specialty 0..0
... location 0..0
... comment 0..0
... extraDetails 0..0
... photo 0..0
... telecom 0..0
... coverageArea 0..0
... serviceProvisionCode 0..0
... eligibility 0..0
... program 0..0
... communication 0..0
... referralMethod 0..0
... appointmentRequired 0..0
... availableTime 0..0
... notAvailable 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AsHealthcareServiceHealthcareActivityProfileThe 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
... 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).
... active ?!Σ1..1booleanWhether this HealthcareService record is in active use
... providedBy SΣC0..1Reference(FrOrganization | AS Organization Profile)Référence vers l'id de la structure FINESS ET à laquelle est rattachée cette activité sanitaire (idNat_Struct).
... category SΣ0..*CodeableConceptLa modalité étant un mode d’application ou un type de soin prévu par les textes réglementaires encadrant chaque activité de soins (modalite).
Binding: JDV_J132-ModaliteActivite-RASS (required)
... characteristic S0..*CodeableConceptLa forme d'activité étant un type d’organisation de prise en charge (forme).
Binding: JDV_J134-FormeActivite-RASS (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.categoryrequiredJDV_J132-ModaliteActivite-RASS
HealthcareService.characteristicrequiredJDV_J134-FormeActivite-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-1errorHealthcareService.meta.extension:as-ext-data-trace, HealthcareService.extension:as-ext-healthcareservice-authorization, HealthcareService.modifierExtension, HealthcareService.eligibility.modifierExtension, HealthcareService.availableTime.modifierExtension, HealthcareService.notAvailable.modifierExtensionMust 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..*AsHealthcareServiceHealthcareActivityProfileThe 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
... 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
... 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).
... active ?!Σ1..1booleanWhether this HealthcareService record is in active use
... providedBy SΣC0..1Reference(FrOrganization | AS Organization Profile)Référence vers l'id de la structure FINESS ET à laquelle est rattachée cette activité sanitaire (idNat_Struct).
... category SΣ0..*CodeableConceptLa modalité étant un mode d’application ou un type de soin prévu par les textes réglementaires encadrant chaque activité de soins (modalite).
Binding: JDV_J132-ModaliteActivite-RASS (required)
... type Σ0..*CodeableConceptCatégorie d'activité de soin autorisée. Exemple : Activités de soins Soumises à Reconnaissance contractuelle
Binding: JDV_J131-CategorieActiviteSanitaireRegulee-RASS (required)
... characteristic S0..*CodeableConceptLa forme d'activité étant un type d’organisation de prise en charge (forme).
Binding: JDV_J134-FormeActivite-RASS (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.meta.securityextensibleAll Security Labels
HealthcareService.meta.tagexampleCommonTags
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.categoryrequiredJDV_J132-ModaliteActivite-RASS
HealthcareService.typerequiredJDV_J131-CategorieActiviteSanitaireRegulee-RASS
HealthcareService.eligibility.codeexample
HealthcareService.characteristicrequiredJDV_J134-FormeActivite-RASS
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

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-1errorHealthcareService.meta.extension, HealthcareService.meta.extension:as-ext-data-trace, HealthcareService.extension, HealthcareService.extension:as-ext-healthcareservice-authorization, HealthcareService.modifierExtension, HealthcareService.eligibility.extension, HealthcareService.eligibility.modifierExtension, HealthcareService.availableTime.extension, HealthcareService.availableTime.modifierExtension, HealthcareService.notAvailable.extension, HealthcareService.notAvailable.modifierExtensionMust 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.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'))

This structure is derived from AsHealthcareServiceHealthcareActivityProfile

Summary

Mandatory: 1 element
Prohibited: 18 elements

Differential View

This structure is derived from AsHealthcareServiceHealthcareActivityProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AsHealthcareServiceHealthcareActivityProfileThe details of a healthcare service available at a location
... active 1..1booleanWhether this HealthcareService record is in active use
... specialty 0..0
... location 0..0
... comment 0..0
... extraDetails 0..0
... photo 0..0
... telecom 0..0
... coverageArea 0..0
... serviceProvisionCode 0..0
... eligibility 0..0
... program 0..0
... communication 0..0
... referralMethod 0..0
... appointmentRequired 0..0
... availableTime 0..0
... notAvailable 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*AsHealthcareServiceHealthcareActivityProfileThe 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
... 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).
... active ?!Σ1..1booleanWhether this HealthcareService record is in active use
... providedBy SΣC0..1Reference(FrOrganization | AS Organization Profile)Référence vers l'id de la structure FINESS ET à laquelle est rattachée cette activité sanitaire (idNat_Struct).
... category SΣ0..*CodeableConceptLa modalité étant un mode d’application ou un type de soin prévu par les textes réglementaires encadrant chaque activité de soins (modalite).
Binding: JDV_J132-ModaliteActivite-RASS (required)
... characteristic S0..*CodeableConceptLa forme d'activité étant un type d’organisation de prise en charge (forme).
Binding: JDV_J134-FormeActivite-RASS (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.categoryrequiredJDV_J132-ModaliteActivite-RASS
HealthcareService.characteristicrequiredJDV_J134-FormeActivite-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-1errorHealthcareService.meta.extension:as-ext-data-trace, HealthcareService.extension:as-ext-healthcareservice-authorization, HealthcareService.modifierExtension, HealthcareService.eligibility.modifierExtension, HealthcareService.availableTime.modifierExtension, HealthcareService.notAvailable.modifierExtensionMust 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..*AsHealthcareServiceHealthcareActivityProfileThe 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
... 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
... 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).
... active ?!Σ1..1booleanWhether this HealthcareService record is in active use
... providedBy SΣC0..1Reference(FrOrganization | AS Organization Profile)Référence vers l'id de la structure FINESS ET à laquelle est rattachée cette activité sanitaire (idNat_Struct).
... category SΣ0..*CodeableConceptLa modalité étant un mode d’application ou un type de soin prévu par les textes réglementaires encadrant chaque activité de soins (modalite).
Binding: JDV_J132-ModaliteActivite-RASS (required)
... type Σ0..*CodeableConceptCatégorie d'activité de soin autorisée. Exemple : Activités de soins Soumises à Reconnaissance contractuelle
Binding: JDV_J131-CategorieActiviteSanitaireRegulee-RASS (required)
... characteristic S0..*CodeableConceptLa forme d'activité étant un type d’organisation de prise en charge (forme).
Binding: JDV_J134-FormeActivite-RASS (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.meta.securityextensibleAll Security Labels
HealthcareService.meta.tagexampleCommonTags
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.categoryrequiredJDV_J132-ModaliteActivite-RASS
HealthcareService.typerequiredJDV_J131-CategorieActiviteSanitaireRegulee-RASS
HealthcareService.eligibility.codeexample
HealthcareService.characteristicrequiredJDV_J134-FormeActivite-RASS
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

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-1errorHealthcareService.meta.extension, HealthcareService.meta.extension:as-ext-data-trace, HealthcareService.extension, HealthcareService.extension:as-ext-healthcareservice-authorization, HealthcareService.modifierExtension, HealthcareService.eligibility.extension, HealthcareService.eligibility.modifierExtension, HealthcareService.availableTime.extension, HealthcareService.availableTime.modifierExtension, HealthcareService.notAvailable.extension, HealthcareService.notAvailable.modifierExtensionMust 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.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'))

This structure is derived from AsHealthcareServiceHealthcareActivityProfile

Summary

Mandatory: 1 element
Prohibited: 18 elements

 

Other representations of profile: CSV, Excel, Schematron