Service d'Accès aux Soins
0.1.0 - ci-build France flag

Publication Build: This will be filled in by the publication tooling

Création de rendez-vous

Caractéristiques de l’API

Endpoint

 

Header

Accept: application/json+fhir

Encodage

UTF-8

Version FHIR

4.0.1

Version package

 

Publication

 

Construction de la requête de base

Interaction FHIR

Create[1]

Méthode http associée

POST

Ressource créée

Appointment

Construction requête de base

POST[base]/Appointment{?_format=[mime-type]}

[1] https://www.hl7.org/fhir/http.html#create et https://www.hl7.org/fhir/http.html#general

Construction de la réponse de base

Réponse de base – Succès

Lien vers la spécification FHIR : https://www.hl7.org/fhir/bundle.html

Si la création est un succès, le serveur répond :

  • Un header avec un code 201 Created HTTP
  • Un header Location incluant l’ID de la ressource créée par le serveur Location: [base]/Appointment/12345

Plus de précision sur la spécification FHIR : https://www.hl7.org/fhir/http.html

Réponse de base – Echec

Lien vers la spécification FHIR : https://www.hl7.org/fhir/operationoutcome.html

Si la recherche échoue, le serveur doit répondre :

  • Un header avec un un code erreur HTTP 4XX ou 5XX

  • Un body contenant une ressource OperationOutcome[^3] qui donne les détails sur la raison de l’échec

À titre d’information, les codes erreurs classiques sont les suivants :

  • 400 (Bad request) – Le format de la requête FHIR transmise est incorrect
  • 422 (Unprocessable Entity) – L’action demandée ne peut pas être réalisée à cause d’une règle interne à l’application.

Plus de précision sur la spécification FHIR : https://www.hl7.org/fhir/http.html

Exemple de requête

Requête :

post[BASE]/Appointment

Corps de la requête :

La requête ci-dessous correspond à la transmission d’un RDV pris par le régulateur avec un identifiant national 3456780581/11242343 avec le PS dont le RPPS est 810100050075 pour le 04/09 à 14h.

{
  "resourceType": "Appointment",
  "id": "1",
  "meta": {
    "profile": [
      "http://interopsante.org/fhir/StructureDefinition/FrAppointmentSAS"
    ]
  },
  "identifier": [
    {
      "system": "urn:oid:1.1.111.1.11.1.1.1",
      "value": "b6e39355-8a61-4556-b340-36f7b95fec6a"
    }
  ],
  "extension": [
    {
      "url": "http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator",
      "valueReference": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "http://interopsante.org/fhir/CodeSystem/fr-v2-0203",
                "code": "IDNPS"
              }
            ]
          },
          "system": "urn:oid:1.2.250.1.71.4.2.1",
          "value": "3456780581/11242343"
        }
      }
    }
  ],
  "status": "booked",
  "start": "2022-09-04T14:00:00+01:00",
  "end": "2022-09-04T14:15:00+01:00",
  "participant": [
    {
      "actor": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "http://interopsante.org/fhir/CodeSystem/fr-v2-0203",
                "code": "IDNPS"
              }
            ]
          },
          "system": "urn:oid:1.2.250.1.71.4.2.1",
          "value": "810100050075"
        }
      },
      "status": "accepted"
    }
  ]
}