Page Status: Updated 2022-10-21
Request FHIR Payload Examples
The FHIR-resources Observation, Patient, Organization and Device are used to supply the data needed for a Digital Covid Certificate. The main resource is Observation and the Patient, Organization and Device are provided as contained resources.
Below are some examples for different scenarios. Each scenario is described on the separate pages below. The example files can be downloaded in different formats from the links provided on each page.
All examples are conformant to the FHIR standard. Two different kinds of examples are provided, one set with minimal payload, and one set containing FHIR profile data. The FHIR profile data is not needed in the request to the Covidbevis API, but can be helpful for understanding the examples.
Element | Comment |
---|---|
resourceType | Denotes the FHIR resourceType and is part of the structure. These elements are handled equal in each request |
id on top level | Can be omitted. id is not needed in the request, but has to be used in the examples to get Simplifier to handle the examples correctly |
conatined | Part of the structure |
id in contained resorce | Mandatory. Does not have to be globally unique, only within the request. The ids from the examples can be used |
Patient.identifier | FHIR handles patient.identifer as a list of identifiers. In Covidbevis only one identifier instance is allowed. The type is a either Swedish personal identity number, personnummer, or a Swedish coordination number, samordningsnummer. |
Patient.identifier.system | Denotes if the provided identifier is of the type "Swedish personal identity number", personnummer, or "Swedish coordination number", samordningsnummer. |
Patient.contact.extension | Structure that can hold information about a patient's guardian. |
Patient.contact.extension.valueReference.identifier | Structure that can hold information about a patient guardian's personal identity number. |
Patient.contact.relationship | Points out the kind of relationship between the patient and the contact. Must be set to "GUARD" |
Patient.contact.name.use | The name.use is provided to be FHIR conformant |
Patient.name | FHIR handles patient.name as a list of names. In Covidbevis only one name instance is allowed |
device.identifier | The identifier of the test device used from the EU database |
device.identifier.system | Describes the device.identifier as an identifier from the EU list of approved test devices |
deviceName | FHIR handles deviceName as a list of device names. In Covidbevis only one deviceName instance is allowed |
deviceName.name | The name of the device in plain text |
deviceName.type | Describes the name as the manufacturers name of the test device. The value "manufacturer-name" must be provided in requests containing deviceName.name to be able to be FHIR conformant |
Observation.identifier | A unique identifer for the perfomed test. Must be unique within the scope of each care giver |
Observation.identifier.use | Describes the identifier to be a temporary identifier |
status | The status of the Observation to be final. Must be provided to be able to be FHIR conformant |
code.coding.system is http://loinc.org | A code from the code system Loinc is used to describe the type of test performed, RAT or NAAT. Supply the corresponding code in code.coding.code for RAT or NAAT |
code.coding.system is http://snomed.info/sct | A code from the code system Snomed CT is used to describe the desease. Supply the corresponding code in code.coding.code for Covid-19 |
subject | A reference to the contained Paitent resource |
performer | A reference to the contained Organization resource |
valueCodableConcept.coding.system | A code from the code system Snomed CT is used to describe the test result. Supply the code for "Not detected" or the code for "Detected" |
device | A reference to the contained Device resource |