Skip to Content
SDK 1.14 is out with per-user product usage and typed API errors. Read the changelog →

FHIR interface

For structured data, Squire offers a FHIR interface that allows you to receive FHIR resources. These include:

  • Observations made by the healthcare provider
  • Conditions assessed during the consultation
  • Procedures performed
  • Medications prescribed

The granularity of which details are included per resources can vary depending on what is discussed during the consultation.

FHIR bundle

A collection of FHIR resources from a consultation is exposed as a FHIR bundle.

{ "resourceType": "Bundle", "type": "collection", "entry": [ { // FHIR resource 1 }, { // FHIR resource 2 } ] }

Resources

Observation

Observation resources are exposed for measurements and other observations made during a consultation. The following is an example of a body weight observation:

{ "resourceType": "Observation", "status": "final", "code": { "coding": [ { "system": "http://loinc.org", "code": "29463-7", "display": "Body weight" } ], "text": "Body weight" }, "subject": { "reference": "Patient/example" }, "effectiveDateTime": "2025-01-01T10:00:00+00:00", "performer": [ { "reference": "Practitioner/example", "display": "Dr. John Smith" } ], "valueQuantity": { "value": 68, "unit": "kg", "system": "http://unitsofmeasure.org", "code": "kg" } }

Condition

When conditions are assessed during a consultation, they are exposed as condition resources. The following is an example of a hypertension condition:

{ "resourceType": "Condition", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "38341003", "display": "Hypertension" } ], "text": "Hypertension" }, "subject": { "reference": "Patient/example" }, "encounter": { "reference": "Encounter/example" }, "onsetDateTime": "2025-01-01", "recordedDate": "2025-01-01", "recorder": { "reference": "Practitioner/example", "display": "Dr. John Smith" } }

Procedure

When procedures are done during the consultation, they are exposed as procedure resources. The following is an example of a procedure:

{ "resourceType": "Procedure", "status": "completed", "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "103693007", "display": "Diagnostic procedure" } ], "text": "Minor surgical procedure" }, "subject": { "reference": "Patient/example" }, "performedPeriod": { "start": "2025-01-01T11:00:00+01:00", "end": "2025-01-01T11:30:00+01:00" }, "encounter": { "reference": "Encounter/example" }, "bodySite": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "83738005", "display": "Finger structure" } ], "text": "Right index finger" } ], "outcome": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/procedure-outcome", "code": "successful", "display": "Successful" } ], "text": "Wound cleaned and sutured successfully" }, "followUp": [ { "text": "Stitch removal in 10 days, monitor for infection" } ] }

MedicationRequest

When medications are prescribed during a consultation, they are exposed as medication request resources. The following is an example of a paracetamol prescription:

{ "resourceType": "MedicationRequest", "status": "active", "intent": "order", "medicationCodeableConcept": { "coding": [ { "system": "https://www.ehealth.fgov.be/standards/reference/fhir/CodeSystem/cnk", "code": "1234567", "display": "Paracetamol EG 1g Tablet" } ] }, "subject": { "reference": "Patient/example" }, "authoredOn": "2025-01-01", "dosageInstruction": [ { "text": "Take 1 tablet orally every 6 hours as needed for pain", "timing": { "repeat": { "frequency": 4, "period": 1, "periodUnit": "d" } }, "route": { "coding": [ { "system": "http://snomed.info/sct", "code": "26643006", "display": "Oral route" } ] }, "doseAndRate": [ { "doseQuantity": { "value": 1, "unit": "tablet", "system": "http://unitsofmeasure.org", "code": "{tbl}" } } ] } ] }

Country-specific resources

Squire supports country-specific implementations for FHIR resources. Currently, Squire offers extensions for eHealth Belgium FHIR Resources.

Last updated on