Répertoire national de l’Offre et des Ressources en santé et accompagnement médico-social
0.4.0-snapshot-2 - ci-build France flag

Répertoire national de l’Offre et des Ressources en santé et accompagnement médico-social - Local Development build (v0.4.0-snapshot-2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: Serveur de prod ROR 3.2

Official URL: https://interop.esante.gouv.fr/ig/fhir/ror/CapabilityStatement/ror-serveur-prod Version: 0.4.0-snapshot-2
Active as of 2024-07-29 Computable Name: RestServer

Capability Statement du Système ROR National version 3.2 mis en production en juilet 2024.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement ror-serveur-prod

Serveur de prod ROR 3.2

  • Implementation Guide Version: 0.4.0-snapshot-2
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, xml, application/fhir+json, json
  • Supported Patch Formats:
  • Published on: 2024-07-29 09:03:47+0000
  • Published by: ANS

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
HealthcareServicehttp://hl7.org/fhir/StructureDefinition/HealthcareServiceyy_filter, _id, _include, _include:iterate, _lastUpdated, _revinclude, _revinclude:iterate, _tag, age-range-high, age-range-low, characteristic, identifier, intervention-zone, location._id, location._lastUpdated, location._tag, location.additional-bed-type, location.address-city, location.address-postalcode, location.capacity-closing-type, location.capacity-status, location.capacity-type, location.capacity-update-date, location.commune-cog, location.crisis-type, location.equipment-feature, location.equipment-type, location.gender-capacity-available, location.identifier, location.identifier:of-type, location.limit-value, location.nb-capacity, location.near, location.near-insee-code, location.residential-number, location.residential-type, location.status, location.temporality-capacity, location.temporary-assignement, location.type, name, notavailable-closing-reopeningdate, organization._id:above, organization._lastUpdated:above, organization._tag:above, organization.closing-type:above, organization.drop-zone:above, organization.identifier:above, organization.name:above, organization.price-amount-value:above, organization.price-dependency-level:above, organization.price-residential-type:above, organization.price-type:above, organization.price-unit:above, organization.price-validity-start-date:above, organization.price-welcome-type:above, organization.special-price:above, organization.type:above, patient-type, practitioner.identifier, psychiatric-sector, service-category, service-type, specialty, specific-competence*
Locationhttp://hl7.org/fhir/StructureDefinition/Locationyy_filter, _has, _id, _lastUpdated, _revinclude, _tag, additional-bed-type, address-city, address-postalcode, capacity-closing-type, capacity-status, capacity-type, capacity-update-date, commune-cog, crisis-type, equipment-feature, equipment-type, gender-capacity-available, identifier, limit-value, nb-capacity, near, near-insee-code, residential-number, residential-type, status, temporality-capacity, temporary-assignement, type*
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony*
Organizationhttp://hl7.org/fhir/StructureDefinition/Organizationyy_content, _id, _lastUpdated, _tag, closing-type, drop-zone, extension.typeActivity, identifier, name, period-end, price-amount-value, price-dependency-level, price-residential-type, price-type, price-unit, price-validity-start-date, price-welcome-type, special-price*
Practitionerhttp://hl7.org/fhir/StructureDefinition/Practitioneryy_id, _lastUpdated, _tag*
PractitionerRolehttp://hl7.org/fhir/StructureDefinition/PractitionerRoleyy_id, _lastUpdated, _tag*

Base System Profile
HealthcareService
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_filterstring
SHALL_idtoken

The ID of the resource

SHALL_includestring
SHALL_include:iteratestring
SHALL_lastUpdateddate
SHALL_revincludestring
SHALL_revinclude:iteratestring
SHALL_tagtoken
SHALLage-range-highquantity
SHALLage-range-lowquantity
SHALLcharacteristictoken

One of the HealthcareService's characteristics

SHALLidentifiertoken

External identifiers for this item

SHALLintervention-zonetoken
SHALLlocation._idtoken

The location of the Healthcare Service

SHALLlocation._lastUpdateddate

The location of the Healthcare Service

SHALLlocation._tagtoken

The location of the Healthcare Service

SHALLlocation.additional-bed-typetoken

The location of the Healthcare Service

SHALLlocation.address-citystring

The location of the Healthcare Service

SHALLlocation.address-postalcodestring

The location of the Healthcare Service

SHALLlocation.capacity-closing-typetoken

The location of the Healthcare Service

SHALLlocation.capacity-statustoken

The location of the Healthcare Service

SHALLlocation.capacity-typetoken

The location of the Healthcare Service

SHALLlocation.capacity-update-datedate

The location of the Healthcare Service

SHALLlocation.commune-cogtoken

The location of the Healthcare Service

SHALLlocation.crisis-typetoken

The location of the Healthcare Service

SHALLlocation.equipment-featuretoken

The location of the Healthcare Service

SHALLlocation.equipment-typetoken

The location of the Healthcare Service

SHALLlocation.gender-capacity-availabletoken

The location of the Healthcare Service

SHALLlocation.identifiertoken

The location of the Healthcare Service

SHALLlocation.identifier:of-typetoken

The location of the Healthcare Service

SHALLlocation.limit-valuequantity

The location of the Healthcare Service

SHALLlocation.nb-capacitynumber

The location of the Healthcare Service

SHALLlocation.nearspecial

The location of the Healthcare Service

SHALLlocation.near-insee-codespecial

The location of the Healthcare Service

SHALLlocation.residential-numbernumber

The location of the Healthcare Service

SHALLlocation.residential-typetoken

The location of the Healthcare Service

SHALLlocation.statustoken

The location of the Healthcare Service

SHALLlocation.temporality-capacitytoken

The location of the Healthcare Service

SHALLlocation.temporary-assignementtoken

The location of the Healthcare Service

SHALLlocation.typetoken

The location of the Healthcare Service

SHALLnamestring

A portion of the Healthcare service name

SHALLnotavailable-closing-reopeningdatedate
SHALLorganization._id:abovetoken

The organization that provides this Healthcare Service

SHALLorganization._lastUpdated:abovedate

The organization that provides this Healthcare Service

SHALLorganization._tag:abovestring

The organization that provides this Healthcare Service

SHALLorganization.closing-type:abovetoken

The organization that provides this Healthcare Service

SHALLorganization.drop-zone:abovetoken

The organization that provides this Healthcare Service

SHALLorganization.identifier:abovestring

The organization that provides this Healthcare Service

SHALLorganization.name:abovestring

The organization that provides this Healthcare Service

SHALLorganization.price-amount-value:abovenumber

The organization that provides this Healthcare Service

SHALLorganization.price-dependency-level:abovetoken

The organization that provides this Healthcare Service

SHALLorganization.price-residential-type:abovetoken

The organization that provides this Healthcare Service

SHALLorganization.price-type:abovetoken

The organization that provides this Healthcare Service

SHALLorganization.price-unit:abovetoken

The organization that provides this Healthcare Service

SHALLorganization.price-validity-start-date:abovedate

The organization that provides this Healthcare Service

SHALLorganization.price-welcome-type:abovetoken

The organization that provides this Healthcare Service

SHALLorganization.special-price:abovetoken

The organization that provides this Healthcare Service

SHALLorganization.type:abovetoken

The organization that provides this Healthcare Service

SHALLpatient-typetoken
SHALLpractitioner.identifierstring
SHALLpsychiatric-sectorstring
SHALLservice-categorytoken

Service Category of the Healthcare Service

SHALLservice-typetoken

The type of service provided by this healthcare service

SHALLspecialtytoken

The specialty of the service provided by this healthcare service

SHALLspecific-competencetoken
 
Base System Profile
Location
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_filterstring
SHALL_hasstring
SHALL_idtoken

The ID of the resource

SHALL_lastUpdateddate
SHALL_revincludestring
SHALL_tagtoken
SHALLadditional-bed-typetoken
SHALLaddress-citystring

A city specified in an address

SHALLaddress-postalcodestring

A postal code specified in an address

SHALLcapacity-closing-typetoken
SHALLcapacity-statustoken
SHALLcapacity-typetoken
SHALLcapacity-update-datedate
SHALLcommune-cogtoken
SHALLcrisis-typetoken
SHALLequipment-featuretoken
SHALLequipment-typetoken
SHALLgender-capacity-availabletoken
SHALLidentifiertoken

An identifier for the location

SHALLlimit-valuequantity
SHALLnb-capacitynumber
SHALLnearspecial

Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant)

Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency.

Requires the near-distance parameter to be provided also

SHALLnear-insee-codespecial
SHALLresidential-numbernumber
SHALLresidential-typetoken
SHALLstatustoken

Searches for locations with a specific kind of status

SHALLtemporality-capacitytoken
SHALLtemporary-assignementtoken
SHALLtypetoken

A code for the type of location

 
Base System Profile
OperationDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Base System Profile
Organization
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring
SHALL_idtoken

The ID of the resource

SHALL_lastUpdateddate
SHALL_tagtoken
SHALLclosing-typetoken
SHALLdrop-zonestring
SHALLextension.typeActivitytoken
SHALLidentifiertoken

Any identifier for the organization (not the accreditation issuer's identifier)

SHALLnamestring

A portion of the organization's name or alias

SHALLperiod-enddate
SHALLprice-amount-valuenumber
SHALLprice-dependency-leveltoken
SHALLprice-residential-typetoken
SHALLprice-typetoken
SHALLprice-unittoken
SHALLprice-validity-start-datedate
SHALLprice-welcome-typetoken
SHALLspecial-pricetoken
 
Base System Profile
Practitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

The ID of the resource

SHALL_lastUpdateddate
SHALL_tagtoken
 
Base System Profile
PractitionerRole
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

The ID of the resource

SHALL_lastUpdateddate
SHALL_tagtoken
 

Operations

Use