With Patient Information API

3. Search the patient

  • Search the patient concerned by the document(s) by using the Access Patient Information API. Once you've found the right patient, you need to keep the FHIR id of your patient to send your document.

  • Search the encounter concerned by the document(s) by using the Access Encounter Information API. This step is optional but we encourage you to add this information in order to add more details information in your structured mail. Once you've found the right encounter, you need to keep the FHIR id of your encounter to send your document as well.

4. Send the medical document(s)

In this step, you'll proceed to sending a medical document and you'll use all the references you've kept in the previous steps.

You need to complete the following information :

ParameterTypeDescriptionMandatory fields
subject Referencepatient subject of your document
context Referenceencounter's patientoptional
recipientsResourceall the recipients, with their mssante email addresses. Either the Lifen reference or the RPPS/Finess number
sender
or
sender-identifier
Reference or
string
Practitioner who signed the document. Either the Lifen reference or the RPPS numberoptional (only one between sender or sender-identifier must be added)
payload parameter :typeCodefor each document, you must choose the type of the document referring to the list Document Type
payload parameter : content.attachment.content-typeCodefor each document, you must describe the content-type of the document application/pdf (no other type currently supported)
payload parameter : content.attachment.database64all documents, in base64 format
// with Patient Information API
// with recipient identified by the Lifen ID
{
   "resourceType":"Parameters",
   "parameter":[
      {
         "name":"payload",
         "part":[
            {
              "name":"document",
              "resource": {
                "resourceType":"DocumentReference",
                "type":{
                  "coding":[{
                    "system":"urn:oid:2.16.840.1.113883.6.1",
                    "code":"11488-4"
                  }]
                },
                "content":[{
                  "attachment":{
                    "content-type":"application/pdf",
                    "data":"{{document in base 64}}"
                  }
                }]
              }
						}
         ]
      },
      {
         "name":"recipients",
         "part":[
            {
               "name":"recipient",
               "resource":{
                  "resourceType":"Practitioner",
                  "id":"456",
                  "telecom":[
                     {
                        "id":"42995", // optional
                        "system":"email",
                        "value":"[email protected]"
                     }
                  ]
               }
            }
         ]
      },
      {
         "name":"subject",
         "valueReference":{
           "reference": "Patient/456"
         }
      },
     {
         "name":"context", // optional
         "valueReference":{
           "reference": "Encounter/5555"
         }
      },
     {
         "name":"sender",
         "valueReference": {
						"reference": "Practitioner/3434545"
					}
      }
     /* either sender or sender-identifier 
     {
         "name":"sender-identifier", // optional
         "valueString": "12345678910"
      },
     */
   ]
}
// with Patient Information API
// with recipient identified by their RPPS
{
   "resourceType":"Parameters",
   "parameter":[
      {
         "name":"payload",
         "part":[
            {
              "name":"document",
              "resource": {
                "resourceType":"DocumentReference",
                "type":{
                  "coding":[{
                    "system":"urn:oid:2.16.840.1.113883.6.1",
                    "code":"11488-4"
                  }]
                },
                "content":[{
                  "attachment":{
                    "content-type":"application/pdf",
                    "data":"{{document in base 64}}"
                  }
                }]
              }
						}
         ]
      },
      {
         "name":"recipients",
         "part":[
            {
               "name":"recipient",
               "resource":{
                  "resourceType":"Practitioner",
                  "identifier": [
                    {
                      "system": "http://rpps.fr",
                      "value": "811111111111111" //RPPS
                    }
                 ],
                  "telecom":[
                     {
                        "id":"42995", // optional
                        "system":"email",
                        "value":"[email protected]"
                     }
                  ]
               }
            }
         ]
      },
      {
         "name":"subject",
         "valueReference":{
           "reference": "Patient/456"
         }
      },
     {
         "name":"context", // optional
         "valueReference":{
           "reference": "Encounter/5555"
         }
      },
     {
         "name":"sender",
         "valueReference": {
						"reference": "Practitioner/3434545"
					}
      }
     /* either sender or sender-identifier 
     {
         "name":"sender-identifier", // optional
         "valueString": "12345678910"
      },
     */
   ]
}