Cambio Core profile for communicating the vital sign, Blood pressure. The profile is not intended to be used as is. When implementing, use profiles that are derived from this one.

Introduction

AppointmentBookingSe is a profile based on the FHIR resource Appointment.

Intended Use

AppointmentBookingSe is used for patients scheduling a new appointment. An appointment needs information about the patient, the healthcare service to be performed, as well as a slot for booking the appointment. AppointmentBookingSe is profiled for the Swedish market.

Versions

Statuses

APIs & Supported Operations

Supported Queries

POST [baseURL]/Appointment (Post)

Introduction

AppointmentCancellationSe is a profile based on the FHIR resource Appointment.

Intended Use

AppointmentCancellationSe is used when a patient cancels an appointment. AppointmentCancellationSe is profiled for the Swedish market.

Versions

Statuses

APIs & Supported Operations

Supported Queries

PUT [baseURL]/Appointment/[id] (Put)

Introduction

AppointmentRebookingSe is a profile on the FHIR resource Appointment.

Intended Use

AppointmentRebookingSe is used for rebooking a scheduled appointment. AppointmentRebookingSe is profiled for the Swedish market.

Versions

Statuses

APIs & Supported Operations

Supported Queries

PUT [baseURL]/Appointment/[id] (Put)

Introduction

AppointmentSe is a profile based on the FHIR resource Appointment.

Intended Use

AppointmentSe is used for appointments. The profile can be used either to request all appointments for a patient, or request information for a single appointment. AppointmentSe is profiled for the Swedish market.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

A limitation to these APIs is that they are only applicable for appointments that are seen as web appointments in COSMIC. Web appointments are appointments that patients can see in an app or on a website outside of COSMIC. The appointment becomes a web appointment through configuration done in COSMIC, see requirements below.

A web appointment must adhere to the following rules in COSMIC:

• The unit which the appointment is connected to, should have the unit type 'Bokning via webbtidbok'.
• The offer/healthcare service which the appointment is connected to, should have the property 'show offer in web schedule' with selected value 'yes'.

Specific Rules and Limitations

Versions

Extensions

Statuses

APIs & Supported Operations

Search Parameters

Supported Queries

GET [baseURL]/Appointment/_search?_id=<appointmentId>&patient.identifier=rn:oid:1.2.752.129.2.1.3.1|<patient personal number>
GET [baseURL]/Appointment/_search?patient.identifier=urn:oid:1.2.752.129.2.1.3.1|<patient personal number> GET [baseURL]/Appointment/_search?date=[gt_date]&date=[lt_date]&patient.identifier=rn:oid:1.2.752.129.2.1.3.1|<patient personal number>

Supported _include params

The following _include parameters are supported:

1. Appointment:participant:HealthCareService.providedBy

Introduction

BasicHospitalBedSituationSe is created from the Basic resource in FHIR R4 edition.

Intended Use

For the given hospital, return bed overview information including the following:

• Prognosis for responsible units.
• Emergency situation.
• Likely admissions.
• Transfers to other hospitals.

This information can be used to get an overview of the bed situation in a hospital. The intended users of the information provided in this API are healthcare professionals and administrators.

Specific Rules and Limitations

Versions

Extensions

Supported Operations

Search Parameters

Supported Queries

1. GET /Basic/_search?subject={}&_profile={}

Error Codes

Introduction

BasicUnitBedSituationSe is created from the Basic resource in FHIR R4 edition.

Intended Use

For the given unit, return bed overview information. The information can be used to find current and near future prognosis of the bed situation for the requested unit, used to overview the bed situation, finding free beds for patients who needs to be admitted, in cases of overcrowding act on changes in planned inflow or outflow from one or many units, etc.

Specific Rules and Limitations

Versions

Extensions

Supported Operations

Search Parameters

Supported Queries

1. GET /Basic/_search?subject={}&_profile={}

Error Codes

Introduction

BasicUnitOutlierSituationSe is created from the Basic resource in FHIR R4 edition.

Intended Use

Find the number of patients of a given unit(s) outlying at another unit.

E.g., A patient whose responsibility is with unit X is placed in ward Y. If ward Y is not a serving unit of unit X - For unit X, this patient will an outlying patient outlying at ward Y.

Specific Rules and Limitations

Versions

Extensions

Supported Operations

Search Parameters

Supported Queries

1. GET /Basic/_search?subject={}&_profile={}

Error Codes

Introduction

The Medication Dispense Dose Dispensing FHIR API is used to receive Medication Dispense related data. This profile is based on the FHIR resource MedicationDispense.

Intended Use

This profile is intended to be used for posting information related to the dispensing of medications for a patient by a dose dispensing machine.

Versions

Statuses

APIs & Supported Operations

Query Parameters

Supported Queries

1. POST [baseURL]/Bundle

Supported _include params

The _include search parameter enables a FHIR client to fetch a particular clinical resource as well as any other resources that it references. The following _include parameters are supported:

1. encounter
2. location
3. subject
4. performer

Error Codes

No specific error codes for MedicationDispenseDoseDispensing. For common codes, refer to Error handling section.

Introduction

The BundleNews2 profile may be used as a container for sending a NEWS2 and the vital signs used to calculate the NEWS2 to COSMIC. The bundle should contain all vital sign profiles used for calculating a NEWS2 and an observation profile for the NEWS2. The BundleNews2 profile is created from the Bundle resource in FHIR R4 edition.

Intended Use

If the NEWS2 observation is sent in a Bundle where all resources related to the NEWS2 observation are included, the Mediator construct an observation with resources from the bundle as contained resources. When the Observation has been resolved, the Mediator calls the Clinical care module (CCM) to create the NEWS2 score in COSMIC. In COSMIC CCM, the related vital sign resources are used to calculate a NEWS2 total score. If no NEWS2 total score is included in the observation the calculated score is saved on the contact. If the NEWS2 observation includes a NEWS2 total score, this score is validated with the use of the calculated score. If they do not match, an error is sent back to the sending system.

When a NEWS2 observation is created, the internal id of this observation (COSMIC care entry) is included in the content-location header in the response from Mediator.

Specific Rules and Limitations

Versions

APIs & Supported Operations

Supported Queries

1. PUT [baseURL]/subscription/Bundle/external-ID (create/update)

Error Codes

Specific error messages for Bundle are listed below.

Introduction

BundlePrehospitalNote is created from the Bundle resource in FHIR R4 edition.

Intended Use

The BundlePrehospitalNote profile may be used as a container for sending a pre-hospital note from an ambulance system to COSMIC. The bundle contains a QuestionnaireResponse entry, but may also contain other resource entries referenced from the QuestionnaireResponse.

Specific Rules and Limitations

Versions

APIs & Supported Operations

Supported Queries

1. PUT [baseURL]/subscription/Bundle/external-ID (create/update)

Introduction

The BundleTriage profile may be used as a container for sending the ClinicalImpressionRetts and the included vital signs in one data transfer. BundleTriage is created from the Bundle resource in FHIR R4 edition.

Intended Use

If the ClinicalImpression is sent in a Bundle where all resources related to the ClinicalImpression are included, the COSMIC Mediator construct a ClinicalImpression with resources from the bundle as contained resources. When the ClinicalImpression has been resolved, the Mediator calls the COSMIC Triage module to create the triage.

When a RETTS Triage is created, the internal id of this triage (COSMIC care entry) is included in the content-location header in the response from Mediator. This id can then be used for updating an existing RETTS triages. By including the id as an identifier in the request, the old triage with that id will be invalidated and a new one created.

Specific Rules and Limitations

Versions

APIs & Supported Operations

Supported Queries

1. PUT [baseURL]/Bundle/external-ID (create/update)

Error Codes

Specific error messages for Bundle are listed below.

Introduction

The CarePlanSe profile is used to retrieve data about care plans in COSMIC.

Intended Use

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Must Support

The MustSupport-flag indicates which attributes are supported by Cambio, meaning that those can be returned as part of the care plan.

Specific Rules and Limitations

Versions

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/CarePlanSe?subject.identifier=[patientIdentifier]

Supported _include params

• CarePlan:supportingInfo
• CarePlan:contributor
• CarePlan:subject
• CarePlan:author.organization
• CarePlan:author.practitioner

Error Codes

Introduction

The CareplanCordinatedCareSe profile is used for retrieving data about Link care plans in COSMIC. This profile is based on the FHIR resource CarePlan. It includes information like referral date, requester, receiver and also references a QuestionaireResponse resource with care note data.

COSMIC Link supports processes and routines in terms of coordination between actors which provides healthcare and social services to ensure an uninterrupted chain of care.

Intended Use

The intended use for this API is to get information about a patient's coordinated careplans, both active and completed. The coordination plan may contain multiple care notes. List of literal IDs will be returned under the Supporting info so that consumers can fetch each note using the GET API for QuestionnaireResponse. Additionally the API consumer has the possibility to contain these care notes by specifying it in the include parameters.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Versions

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/CarePlan/?subject=[id]&_profile=[] (Search)
2. GET [baseURL]/CarePlan/?subject=[id]&_profile=[]&category=[](Search)
3. GET [baseURL]/CarePlan/?subject=[id]&_profile=[]&category=[]&_include=supportingInfo (Search)
4. GET [baseURL]/CarePlan/?subject=[id]&_profile=[]&category=[]&_include=supportingInfo&_include=contributor (Search)
5. GET [baseURL]/CarePlan/?subject=[id]&_profile=[]&category=[]&_include=contributor (Search)
6. GET [baseURL]/CarePlan/?subject=[id]&_profile=[]&_include=contributor (Search)

Supported _include params

The following _include parameters are supported:

1. supportingInfo
2. contributor

Introduction

​Please note that this version of the ChargeItemSe profile is deprecated and the recommended profile to use is ChargeItemSe(version 2).

ChargeItemSe is a profile intended to be used to enable the billing process and internal cost allocation. This profile is based on the FHIR resource ChargeItem.

Specific Rules and Limitations

Versions

Introduction

​ChargeItemSe is a profile intended to be used to enable the billing process and internal cost allocation. This profile is based on the FHIR resource ChargeItem. The main difference of the version 2 of the profile is that ChargeItem.context refers to the version 2 of the profile EncounterSelfService

Intended Use

​In the context of an invoice this resource is currently used only for linking the Encounter resource with the invoice. For more details, see InvoiceSe. The ChargeItemSe is used as a contained resource within InvoiceSe

Specific Rules and Limitations

Versions

Supported Operations

Not applicable, this profile is just used as a contained resource and there is no API for ChargeItemSe.

Error Codes

Not applicable, this profile is just used as a contained resource and there is no API for ChargeItemSe.

Cambio Core profile for communicating triage data of a patient. Concerns triages calculated using different protocols. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

RETTS triage is a system that is widely used in emergency care in Sweden. The RETTS triage contains a reason for visit, a set of vital parameters and a 'colour' based on a calculataion of the included vital parameters. The colour indicates a priority based on the severity of the patient's condition. The colours included in a RETTS triage in the order of priority are:

1. Red
2. Orange
3. Yellow
4. Green
5. Blue

The ClinicalImpressionTriageRetts profile is based on the FHIR resource ClinicalImpression.

Intended Use

The ClinicalImpressionTriageRetts profile is used to create a RETTS triage in COSMIC from an external ambulance system.

Specific Rules and Limitations

Versions

Supported Operations

Supported Queries

PUT [baseURL]/Bundle/external-ID (create/update)

Error Codes

In below table, a few error messages specific for ClinicalImpression are listed.

Introduction

The CompositionReferralClinicalInformation profile defines clinical information structured on sections with titles and values which can be sent together with a referral request, answer or assessment. E.g. the documentation done when sending a referral can include data like medical history, health issue, etc. This profile is based on the FHIR resource Composition.

Intended Use

Intended use of this profile is to communicate data about a documented clinical information that is connected to a referral request, assessment or answer. The user of the API should be restricted only to the patient to which the data belongs. CompositionReferralClinicalInformation can only be used as a bundled resource within the TaskReferral and ServiceRequestReferral APIs, refer to TaskReferral and ServiceRequestReferral sections to read more about complete Intended use for the API.

Additionally, CompositionReferralClinicalInformation includes the extension common-signDateTime to indicate the date & time the data was signed.

Specific Rules and Limitations

Versions

Introduction

The ConditionDiagnosisSe profile handles information about diagnoses that are documented in a QuestionnaireResponseSe profile. In this profile, the diagnose code system that is handled is ICD10.

Intended Use

ConditionDiagnosisSe is currently only used as a contained resource within QuestionnaireResponse.

Intended user for this resource is only a healthcare professional. This professional should be the same as specified in QuestionnaireResponseSe. If Unit is specified, it should be with HSA id and has to be the same unit as was given in QuestionnaireResponseSe.

Specific Rules and Limitations

Versions

APIs & Supported Operations

Not applicable, this profile is just used as a contained resource and there is no direct APIs related to this profile.

Introduction

The ConditionHealthIssueSe profile serves as a data container for transmitting information about a health issue, detailing a patient's process through healthcare for one or multiple related conditions. This profile is derived from the Condition resource in FHIR R4 edition and tailored specifically for the Swedish healthcare market as the supported SNOMED CT code system is defined for the Swedish market.

Intended Use

This API is designed to retrieve basic information of a patient's active pregnancy, primarily for purposes like linking QuestionnaireResponses. It is advised against presenting this data directly to end-users, hence the specific condition names are not currently exposed and only the code name is returned. Furthermore, storing any fetched information in an external system is discouraged due to the temporary nature of identifier values, which may change (for instance, if a condition is merged with another condition). The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Statuses

Note that the other statuses are not mapped as they are not supported in the API.

Versions

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Condition?subject.identifier=urn:oid:1.2.752.129.2.1.3.1|197305281904&code=http://snomed.info/sct/45991000052106|118185001&category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item

2. GET [baseURL]/Condition?subject.identifier=urn:oid:1.2.752.129.2.1.3.1|197305281904&code=http://snomed.info/sct/45991000052106|118185001&category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item&_include=Condition:subject

3. GET [baseURL]/Condition?subject=Patient/1071&code=http://snomed.info/sct/45991000052106|118185001&category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item

4. GET [baseURL]/Condition?subject=1071&code=http://snomed.info/sct/45991000052106|118185001&category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item

5. GET [baseURL]/Condition?subject.identifier=urn:oid:1.2.752.129.2.1.3.1|197305281904&code=http://snomed.info/sct/45991000052106|118185001&category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item&_include=Condition:subject&_include=Condition:extension:participant:extension:actor

Supported _include params

• Condition:subject
• Condition:extension:participant:extension:actor

Error Codes

Introduction

The ConsentPatientSealProfile represents the consent of the patient for fully sealing their account in an external application and is a profile created from the resource Consent.

Intended Use

The ConsentPatient profile will contain the consent information of the patient to create a fully seal from the patient in direct access framework implemented for Cambio. When a full seal is implemented no information of that patient will be sent to the external application.

Specific Rules and Limitations

Versions

API's & Supported Operations

Search Parameters

Supported Queries

1. POST [baseURL]/Consent
2. GET [baseURL]/Consent?patient=<patient id>
3. GET [baseURL]/Consent?patient.identifier=<systemURI|identifier value>

Core diagnostic report profile, this profile can be used to expose information of any report related resource

Introduction

The DiagnosticReportMicrobiology profile is used for retrieving data about a complete microbiology report for a patient end to end starting from request. This profile is based on the FHIR resource DiagnosticReport.This profile is derived from a core profile created for DiagnosticReport named DiagnosticReportCore. The data available from COSMIC to this profile is only starting from R8.3.03 COSMIC release, information created before this release cannot be taken from this API.

Intended Use

This profile is created as the main profile for the exposing information related to Microbiology report.This profile is based on the core DiagnosticReport profile that is defined for exposing all types of report based resources.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Versions

Statuses

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/DiagnosticReport/[id] (Read)
2. GET [baseURL]/DiagnosticReport/_search?patient=[]&date=[] (Search)
3. GET [baseURL]/DiagnosticReport/_search?patient=[]&date=[]&_include=[] (Search)

Supported _include params

The following _include parameters are supported:

1. patient
2. performer
3. based-on
4. date

Introduction

The DiagnosticReportRadiology profile is used for retrieving data about a complete radiology report for a patient end to end starting from request. This profile is based on the FHIR resource DiagnosticReport.

Intended Use

This profile is created as the main profile for the exposing information related to radiology report. This profile is based on the core DiagnosticReport profile that is defined for exposing all types of report based resources.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Versions

Statuses

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/DiagnosticReport/[id] (Read)
2. GET [baseURL]/DiagnosticReport/_search?patient=[]&date=[] (Search)
3. GET [baseURL]/DiagnosticReport/_search?patient=[]&date=[]&_include=[] (Search)

Supported _include params

The following _include parameters are supported:

1. patient
2. performer
3. based-on
4. date

The EncounterCore is defined as an interaction between a patient and healtcare provider(s) for the purpose of providing healtcare service(s) or assessing the health status of a patient.

The Encounter Emergency is defined as an interaction between a patient and healthcare provider(s) that is not planned. (Not implemented yet)

Introduction

The EncounterLite profile is created from the FHIR resource Encounter.

Intended Use

EncounterLite profile is created to fetch inpatient encounters at a given location.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API. Note that the security rules (i.e. PDL block) are not applied in particularly in this API and Consumer must handle the data carefully and with the awareness.

Specific Rules and Limitations

Versions

Cosmic mappings

The table below shows what the statuses used in this FHIR profile are mapped to in Cosmic.

Supported Operations

Search Parameters

Supported Queries

1. Search [baseURL]/Encounter

Supported _include params

• Encounter:subject
• Encounter:location
• Encounter:serviceProvider

Supported _revinclude params

N/A

Error Codes

For common codes, refer to Error handling section.

Introduction

EncounterLite profile is a lightweight Cambio profile with the intended use of retrieving encounters.
It currently supports two operations, one for fetching ongoing inpatient encounters at a specific care unit (also supported previously in v1) and another one for fetching all types of encounters for a specific patient.

Must Support

The MustSupport-flag indicates which attributes are supported by Cambio, meaning that those can be returned as part of the encounter.

Specific Rules and Limitations

Versions

Supported Operations

Search Parameters for supported operation #1

Search Parameters for supported operation #2

Supported Queries

1. `GET [baseURL]/Encounter

Supported _include params

• Encounter:subject
• Encounter:encounterPerformingUnit
• Encounter:serviceProvider

Error Codes

For common codes, refer to Error handling section.

The Encounter Outpatient is defined as an interaction between a patient and healthcare provider(s) that does not require an overnight stay in a hospital or medical facility. (Not implemented yet)

This is an Encounter profile to be used for outpatient encounters, in a Swedish context.

Introduction

The EncounterOutpatientReadeSe profile is a Cambio profile with the intended use of reading outpatient encounters. This profile is derived from the EncounterOutpatientCoreSe profile.

Must Support

The MustSupport-flag indicates which attributes are supported by Cambio, meaning that those can be returned as part of the encounter.

Versions

Specific Rules and Limitations

Extensions

Supported Operations

Search parameters

Supported Queries

1. GET[baseURL]/Encounter?subject.identifier=[patientIdentifier]&_profile=[profileURL]
2. GET[baseURL]/Encounter?subject.identifier=[patientIdentifier]&_profile=[profileURL]&_include=Encounter:serviceProvider

Supported _include parameters

• Encounter:encounterPerformingUnit
• Encounter:participant
• Encounter:serviceProvider
• Encounter:subject

Introduction

The EncounterOutpatientWriteSe profile is a Cambio profile with the intended use of creating outpatient encounters. This profile is derived from the EncounterOutpatientCoreSe profile.

Example scenario

Create an encounter in the context of an integration between an EHR and a dental care system

1. There is a GP clinic that uses an EHR and a dental clinic that uses the same EHR and a dental care system.
2. A patient is referred from a GP clinic to a dental clinic, referral is sent by GP clinic using the EHR and accepted by the dental clinic using the EHR.
3. The dental clinic creates an appointment in their dental care system for the patient.
4. Patient arrives for the appointment and the patient's arrival is recorded in the dental care system at the dental clinic.
5. In order to manage documentation in the EHR for this visit, an encounter must be created in the EHR. This needs to be done automatically so the practitioners do not have to record the arrival of the patient in multiple systems.

Must Support

The MustSupport-flag indicates which attributes are supported by Cambio, meaning that they will be stored as part of the encounter in the Cambio system. If other attributes are included, as allowed by the profile, it will not throw an error but those will be discarded.

Versions

Cosmic mappings

The table below shows what the statuses used in this FHIR profile are mapped to in Cosmic.

Supported Operations

Supported Queries

1. POST[baseURL]/Encounter

Introduction

The EncounterPrehospital profile is created from the FHIR resource Encounter

Intended Use

EncounterPrehospital is used to create an ambulance contact in COSMIC from an external ambulance system when a patient is coming in to the hospital by ambulance.

Lock Functionality

If a certain type of resource is updated, but with the same (or older) lastUpdatedTime, the update will fail. The code which is returned is 200 OK. If the header prefer:return=OperationOutcome is added, a message will be received describing the error.

Specific Rules and Limitations

Statuses

Versions

Supported Operations

Search Parameters

N/A

Supported Queries

1. PUT [baseURL]subscription/Bundle/external-ID

Supported _include params

N/A

Supported _revinclude params

N/A

Error Codes

No specific error codes for EncounterPrehospital. For common codes, refer to Error handling section.

Introduction

​Please note that this version of the EncounterSelfSevice profile is deprecated and the recommended profile to use is EncounterSelfService(version 2).

The EncounterSelfService profile is used for retriving the contact information needed for self-service workflow (arrival and payment registration). The profile is based on the Encounter in FHIR STU4 edition.

Specific Rules and Limitations

Versions

Introduction

The EncounterSelfService profile is used for retrieving the contact information needed for self-service workflow (arrival and payment registration). The profile is based on the Encounter resource in the FHIR R4 specification.

In the profile version 2, the extension RegisterPaymentPossible has been removed.

Intended Use

EncounterSelfService is currently only used as a contained resource within the InvoiceSe resource. It contains three extension to include additional details about the visit.

Specific Rules and Limitations

Versions

Extensions

Encounter Statuses

Supported Operations

Not applicable, this profile is just used as a contained resource and there is no API for EncounterSelfService. For examples, refer to InvoiceSe.

Error Codes

Not applicable, this profile is just used as a contained resource and there is no API for EncounterSelfService.

Introduction

HealthcareServiceLiteSe is a profile based on the FHIR resource HealthcareService.

Intended Use

HealthcareServiceLiteSe is used as part of the booking flow, where this profile searches for a list of healthcare services that may be used to book an appointment.

Specific Rules and Limitations

Versions

Extensions

APIs & Supported Operations

Search Parameters

Supported Queries

• GET [baseURL]/HealthcareService/_search?location=<reference>
• GET [baseURL]/HealthcareService/_search?location.identifier=<identifier reference>

Error Codes

In the table below, a few error messages specific for HealthcareServices are listed.

Introduction

The ImmunizationSe profile is used to retrieve data about performed patient vaccinations in COSMIC. The profile is based on the FHIR resource Immunization.

Intended Use

The intended users of this API are patient apps and healthcare professionals.

Specific Rules and Limitations

Extensions

Versions

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Immunization?patient={id}`

2. GET [baseURL]/Immunization?patient.identifier={identifierSystemURI

   identifierValue}`

3. GET [baseURL]/Immunization?patient.identifier={identifierSystemURI

   identifierValue}`&_include=Immunization:location

4. GET [baseURL]/Immunization?patient.identifier={identifierSystemURI

   identifierValue}&_include=Immunization:performer.actor

Error Codes

Introduction

​Please note that this version of the Invoice profile is deprecated and the recommended profile to use is InvoiceSe(version 2).

The Invoice resource contains the payment details related to a single patient visit. The profile is based on the Invoice in FHIR STU4 edition.

Specific Rules and Limitations

Versions

Introduction

The Invoice resource contains the payment details related to a single patient visit. The profile is based on the Invoice in FHIR STU4 edition.

Intended Use

The Invoice resource returns relevant cost for the patient visit. It contains three extensions to include additional details about the payments.

Specific Rules and Limitations

Versions

Extensions

Mapping for Payment Types

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/invoice_search?subject={}&encounter={}&_profile=https://fhir.cambio.se/StructureDefinition/InvoiceSe/v2 (search)

Error Codes

Specific error messages for InvoiceSe are listed below.

A profile for Locations where each location is some type of "unit", it could be an OP unit, IP ward, hospital or similar.

Use other Location profiles for other location types such as Beds.

This is a Core profile, hence is open in its profiling. Consider using more specific profiles derived from this one.

Introduction

LocationUnitSe is a profile based on the FHIR resource Location.

Intended Use

LocationUnitSe is used to communicate care units, where healthcare services for that unit can be found in order for a patient to be able to book appointments.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Versions

Extensions

APIs & Supported Operations

Search Parameters

Supported Queries

GET [baseUrl]/Location/[id] (GET)

Introduction

The Medication Dispense Dose Dispensing FHIR API is used to receive Medication Dispense related data. This profile is based on the FHIR resource MedicationDispense.

Intended Use

This profile is intended to be used for posting information related to the dispensing of medications for a patient by a dose dispensing machine.

Versions

Statuses

APIs & Supported Operations

Query Parameters

Supported Queries

1. POST [baseURL]/MedicationDispense

Introduction

The Medication Request FHIR API is designed to enable the fetching of requested medications for a patient. This profile is based on the FHIR resource MedicationRequest.

Intended Use

This profile is intended to be used for communicating information related to prescribed medication data for a patient that is to be dispensed from a dose dispensing machine. This profile will communicate details of one prescription at a time.

Versions

Statuses

FHIR status Active will be sent always.

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/MedicationRequest?subject.identifier:urn:oid:[OID]|[id]&category=[]&_profile=[https://fhir.cambio.se/StructureDefinition/MedicationRequestDoseDispensing]
2. GET [baseURL]/MedicationRequest?subject.identifier:urn:oid:[OID]|[id]&category=[]&_profile=[https://fhir.cambio.se/StructureDefinition/MedicationRequestDoseDispensing]&date=gt&date=lt
3. GET [baseURL]/MedicationRequest?subject.identifier:urn:oid:[OID]|[id]&category=[]&_profile=[https://fhir.cambio.se/StructureDefinition/MedicationRequestDoseDispensing]&date=gt&date=lt&_include=MedicationRequest:subject
4. GET [baseURL]/MedicationRequest?subject.identifier:urn:oid:[OID]|[id]&category=[]&_profile=[https://fhir.cambio.se/StructureDefinition/MedicationRequestDoseDispensing]&date=gt&date=lt&_include=MedicationRequest:subject&_include=MedicationRequest:requester

Supported _include Parameters

The following _include parameters are supported:

• subject
• practitioner

FHIR Blood Pressure Profile

FHIR Body Height Profile

FHIR Body Temperature Profile

FHIR Body Weight Profile

FHIR Head Circumference Profile

FHIR Heart Rate Profile

FHIR Oxygen Saturation Profile

FHIR Respiratory Rate Profile

Cambio Core profile for communicating the level of consciousness, ACVPU(Alert, Confusion, Voice, Pain, Unresponsive). For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationAcvpuLite profile represents the vital sign ACVPU and is a profile created from the resource Observation. The ACVPU is a scale for the awareness of a patient. The profile is derived from the standard FHIR profile Vital Signs which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The ObservationAcvpuLite profile is used for communicating the awareness of a patient. The level of awareness is communicated as a statement which is defined by a code in the profile.

The API can be used to create and read ACVPU information from/to COSMIC.

Create ACVPU

Patient Generated

• The patient generated data is ordered by a care giver and there should be a responsible unit sent together with the data.

Healthcare Professional

• To create data using this API, the user should be a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment, and be connected, to the specified care unit. The care unit should also be specified with a HSA ID.
• The intended use is in first hand that the API is used within the same caregiver. The user and the specified care unit should exist in COSMIC as well as in the external system.

Read ACVPU

• The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between caregivers, patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient= (Search)
2. GET [baseURL]/Observation/_search?status= (Search)
3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (Search)
4. GET [baseURL]/Observation/_search?_profile= (Search)
5. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (Search)
6. GET [baseURL]/Observation/_search?status=[status]&_include=[] (Search)
7. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[] (Search)
8. GET [baseURL]/Observation/_search?_profile=[url]&_include=[] (Search)
9. POST [baseURL]/Observation (Post)

Supported _include params

Observation:performer

Error Codes

In the table below, a few error messages specific for Observation are listed.

Cambio Core profile for communicating the status of the patients air passage. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationAirpassageLite profile represents the vital sign air passage and is a profile created from the resource Observation. The vital sign air passage holds a status of the patients air passage. The profile is derived from the standard FHIR profile Vital Signs which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The ObservationAirPassageLite profile is used for communicating the status of the air passage of a patient. The status of the air passage is communicated as a statement which is defined by a code in the profile.

The API can be used to create and read air passage information from/to COSMIC.

Create Air Passage

Patient Generated

• The patient generated data is ordered by a care giver and there should be a responsible unit sent together with the data.

Healthcare Professional

• To create data using this API, the user should be a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment (medarbetaruppdrag) and be connected to the specified care unit. The care unit should also be specified with a HSA ID.
• The intended use is in first hand that the API is used within the same caregiver. The user and the specified care unit should exist in COSMIC as well as in the external system.

Read Air Passage

• The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between caregivers, patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient= (Search)
2. GET [baseURL]/Observation/_search?status= (Search)
3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (Search)
4. GET [baseURL]/Observation/_search?_profile= (Search)
5. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (Search)
6. GET [baseURL]/Observation/_search?status=[status]&_include=[] (Search)
7. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[] (Search)
8. GET [baseURL]/Observation/_search?_profile=[url]&_include=[] (Search)
9. POST [baseURL]/Observation (Post)

Supported _include params

_include=Observation:performer

Error Codes

In the table below, a few error messages specific for Observation are listed.

Cambio Core profile for communicating the Arm Span. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationArmSpanLite profile represents the parameter Arm span and is a profile created from the resource Observation which makes the profile compliant with the FHIR standardized way of communicating vital sign data. Arm span is an observation where a measurement taken of the length from one end of an individual's arm (measured at the fingertips) to the other arm, when raised parallel to the ground with shoulder height at a 90° angle.

Intended Use

The profile ObservationArmSpanLite is used for communicating an entry of a patient's measurement of the length from one end of an individual's arm (measured at the fingertips) to the other arm, when raised parallel to the ground with shoulder height at a 90° angle, by sending a value in the element observation.value.

Read Arm Span

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Statuses

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (search)

Error Codes

In the table below, a few error messages specific for observations are listed.

Introduction

The ObservationBPComplex profile represents the vital sign blood pressure and additional information related to the observation such as how the patient's body was positioned at the time for instance. Therefore in comparison to ObservationBPLite, this profile captures more information besides the systolic and diastolic blood pressure values.
The profile is derived from the standard FHIR profile ObservationVitalSigns and ObservationBP which makes the profile compliant with the FHIR standardized way of communicating vital sign data.
The must support flag indicates which attributes that will be stored as part of the observation in a Cambio system.

In COSMIC this observation is mapped to the internal archetype for complex blood pressure.

Specific Rules and Limitations

Versions

Supported Operations

Supported Queries

1. POST [baseURL]/Observation

Concept maps

For integration with Cosmic the following concept maps are used for this profile:

• BP Body Site To Snomed Concept Map
• BP Body Position To Snomed Concept Map

Introduction

The ObservationBPLite profile represents the vital sign Blood pressure and is a profile created from the resource Observation. The vital sign blood pressure can hold both the value of the diastolic and systolic blood pressure of the patient. The profile is derived from the standard FHIR profile Vital Signs which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The ObservationBPLite profile is used for communicating the value of the patient blood pressure in mm[Hg]. If either the systolic or diastolic blood pressure is not included, a value must be sent in Observation.component.dataAbsentReason. In COSMIC it is mapped to the internal archetype for blood pressure.

The API can be used to create and read patient blood pressure information from/to COSMIC.

Create Blood Pressure

Patient Generated

• The patient generated data is ordered by a care giver and there should be a responsible unit sent together with the data.

Healthcare Professional

• To create data using this API, you should be a healthcare professional with a specified HSA ID. This professional should have their assignment, and be connected, to the specified care unit. The care unit should also be specified with a HSA ID.
• The intended use is in first hand that the API is used within the same caregiver. The user and the specified care unit should exist in COSMIC as well as in the external system.

Read Blood Pressure

• The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between caregivers, patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient= (Search)
2. GET [baseURL]/Observation/_search?status= (Search)
3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (Search)
4. GET [baseURL]/Observation/_search?_profile= (Search)
5. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (Search)
6. GET [baseURL]/Observation/_search?status=[status]&_include=[] (Search)
7. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[] (Search)
8. GET [baseURL]/Observation/_search?_profile=[url]&_include=[] (Search)
9. POST [baseURL]/Observation (Post)

Supported _include params

Observation:performer

Error Codes

In the table below, a few error messages specific for Observation are listed.

Cambio Core profile for communicating the Body Height. Also support the different types of body heights like, Target height, Mother height, father height, Sitting height, Birth length. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationBodyHeightLite profile represents the vital parameter body height and is a profile created from the resource Observation. Body height is an observation concerning body height of a person. The profile is derived from the standard FHIR profile Body height which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The profile ObservationBodyHeightLite is used for communicating an entry of a patients body height by sending a value in the element observation.value. The profile defines three different types of body height registrations: Body height, birth length and sitting height. The API can be used to create and read patient body height information from/to COSMIC.

Create Body Height

Patient Generated

The patient generated data is ordered by a care giver and there should be a responsible unit sent together with the data.

Healthcare Professional

Should be done by a health care professional with a specified HSA ID. This professional should have their assignment (medarbetaruppdrag) and be connected to the specified unit. Unit should also be specified with HSA ID. Intended use is in first hand that the API is used within the same care giver. The user and specified unit should exist in COSMIC and be the same in the external system.

Read Body Height

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient= (Search)
2. GET [baseURL]/Observation/_search?status= (Search)
3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (Search)
4. GET [baseURL]/Observation/_search?code= (Search)
5. GET [baseURL]/Observation/_search?_profile= (Search)
6. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (Search)
7. GET [baseURL]/Observation/_search?status=[status]&_include=[] (Search)
8. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[] (Search)
9. GET [baseURL]/Observation/_search?code=[code]&_include=[] (Search)
10. GET [baseURL]/Observation/_search?_profile=[url]&_include=[] (Search)
11. POST [baseURL]/Observation (Post)

Supported _include params

1. Observation:performer
2. Observation:performer.organization
3. Observation:performer.practitioner
4. Observation:subject

Error Codes

In the table below, a few error messages specific for Observation are listed.

Cambio Core profile for communicating the vital sign, Body temperature. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationBodyTemperatureLite profile represents the vital sign body temperature and is a profile created from the resource Observation. The vital sign body temperature holds a value of the temperature of the patient body. The profile is derived from the standard FHIR profile Vital Signs which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The ObservationBodyTemperatureLite is used for communicating the value of the patients body temperature in celsius by sending a value in the element observation.value. The API can be used to create and read patient body temperature information from/to COSMIC.

Create Body Temperature

Patient Generated

• The patient generated data is ordered by a care giver and there should be a responsible unit sent together with the data.

Healthcare Professional

• To create data using this API, the user should be a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment, and be connected, to the specified care unit. The care unit should also be specified with a HSA ID.
• The intended use is in first hand that the API is used within the same caregiver. The user and the specified care unit should exist in COSMIC as well as in the external system.

Read Body Temperature

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient= (Search)
2. GET [baseURL]/Observation/_search?status= (Search)
3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (Search)
4. GET [baseURL]/Observation/_search?_profile= (Search)
5. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (Search)
6. GET [baseURL]/Observation/_search?status=[status]&_include=[] (Search)
7. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[] (Search)
8. GET [baseURL]/Observation/_search?_profile=[url]&_include=[] (Search)
9. POST [baseURL]/Observation (Post)

Error Codes

In the table below, a few error messages specific for Observation are listed.

Cambio Core profile for communicating the Body weight. For Use case specific profiles, this profile can be derived for the use case profile to be compliant with the Cambio core profile.

Introduction

The ObservationBodyWeightLite profile represents the vital parameter body weight and is a profile created from the resource Observation. Body weight is an observation concerning body weight of a person. The profile is derived from the standard FHIR profile Body weight which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The profile ObservationBodyWeightLite is used for communicating an entry of a patients body weight by sending a value in the element observation.value. The API can be used to create and read patient body weight information from/to COSMIC.

Create Body Weight

Patient Generated

• The patient generated data is ordered by a care giver and there should be a responsible unit sent together with the data.

Healthcare Professional

• Should be done by a health care professional with a specified HSA ID. This professional should have their assignment (medarbetaruppdrag) and be connected to the specified unit. Unit should also be specified with HSA ID. Intended use is in first hand that the API is used within the same care giver. The user and specified unit should exist in COSMIC and be the same in the external system.

Read Body Weight

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient= (Search)
2. GET [baseURL]/Observation/_search?status= (Search)
3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (Search)
4. GET [baseURL]/Observation/_search?code= (Search)
5. GET [baseURL]/Observation/_search?_profile= (Search)
6. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (Search)
7. GET [baseURL]/Observation/_search?status=[status]&_include=[] (Search)
8. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[] (Search)
9. GET [baseURL]/Observation/_search?code=[code]&_include=[] (Search)
10. GET [baseURL]/Observation/_search?_profile=[url]&_include=[] (Search)
11. POST [baseURL]/Observation (Post)

Error Codes

In the table below, a few error messages specific for Observation are listed.

Cambio Core profile for communicating the Bone age

Introduction

The ObservationBoneAgeLite profile represents the parameter Bone age and is a profile created from the resource Observation which makes the profile compliant with the FHIR standardized way of communicating vital sign data. Bone age is an observation to indicate the degree of maturation of a child's bones.

This helps doctors estimate the maturity of a child's skeletal system. It's usually done by taking a single X-ray of the left wrist, hand, and fingers. Measured in years.

Intended Use

The profile ObservationBoneAgeLite is used for communicating an entry of degree of maturation of a child's bones, by sending a value in the element observation.value.

Read Bone Age

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (search)

Error Codes

In the table below, a few error messages specific for observations are listed.

Cambio Core profile for communicating the stages of Breast development (female). For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationBreastFemaleLite profile represents the parameter Tanner girls breast stage and is a profile created from the resource Observation which makes the profile compliant with the FHIR standardized way of communicating vital sign data. Tanner girls breast stage is an observation to state the visible stages (tanner stage) of puberty by determining the degree of development of breasts.

Intended Use

The profile ObservationBreastFemaleLite is used for communicating the visible stages (tanner stage) of puberty by determining the degree of development of breasts, by sending a value in the element observation.value.

Read Tanner Girls Breast Stage

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (search)

Error Codes

In the table below, a few error messages specific for observations are listed.

The ObservationClinicalSimple is referred from the QuestionnaireResponsPrehospitalNote. Both quantity and string values are supported. IMORTANT: This observation will not result in a structured observation in the system but will result in a free text in a final note keyword.

Cambio Core profile for communicating the Date of Menarche. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationDateOfMenarcheLite profile represents the parameter Date of menarche and is a profile created from the resource Observation which makes the profile compliant with the FHIR standardized way of communicating vital sign data. Date of menarche is an observation to state the year and the month when the first menstruation happened.

Intended Use

The profile ObservationDateOfMenarcheLite is used for communicating an entry of the year and the month when the first menstruation happened, by sending a value in the element observation.value.

Read Date of Menarche

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (search)

Error Codes

In the table below, a few error messages specific for observations are listed.

Cambio Core profile for communicating the Foot Length. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationFootLengthLite profile represents the parameter Foot Length and is a profile created from the resource Observation which makes the profile compliant with the FHIR standardized way of communicating vital sign data. Foot Length is an observation where a measurement taken of the foot, from the longest toe to the back of the heel.

Intended Use

The profile ObservationFootLengthLite is used for communicating an entry of a patient's measurement taken of the foot, from the longest toe to the back of the heel, by sending a value in the element observation.value.

Read Foot Length

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (search)

Error Codes

In the table below, a few error messages specific for observations are listed.

Cambio Growth chart specific use case profile for communicating the vital parameters, Height of the biological father or height of biological mother, between an external system and COSMIC. The profile includes fields for the value of the height measurement, contextuel data and meta data. GET operation is supported. This profile should be used only for Growh chart related data communication.

Cambio Growth chart specific use case profile for communicating the vital parameters, weight of the biological father or weight of the biological mother, between an external system and COSMIC. The profile includes fields for the value of the weight measurement, contextuel data and meta data. GET operation is supported. This profile should be used only for Growh chart related data communication.

Cambio Core profile for communicating the Genital Stage (Male) For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationGenitalStageMaleLite profile represents the parameter Tanner boys genital stage and is a profile created from the resource Observation which makes the profile compliant with the FHIR standardized way of communicating vital sign data. Tanner boys genital stage is an observation to state the visible stages (tanner stage) of puberty by determining the development of testicle.

Intended Use

The profile Tanner boys genital stage is used for communicating the visible stages (tanner stage) of puberty by determining the development of testicle, by sending a value in the element observation.value.

Read Tanner Boys Genital Stage

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (search)

Error Codes

In the table below, a few error messages specific for observations are listed.

Cambio Core profile for communicating the Head Circumference. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationHeadCircumference profile represents the vital parameter Head Circumference and is a profile created from the resource Observation. Head Circumference is an observation concerning the measurement around the patient's head. The profile is derived from the standard FHIR profile HeadCircumference which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The profile ObservationHeadCircumferenceLite is used for communicating an entry of a patient's Head Circumference, by sending a value in the element observation.value.

Read Head Circumference

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (Search)

Error Codes

In the table below, a few error messages specific for observations are listed.

Introduction

The ObservationHeadCircumferenceRelative profile represents the vital parameter Head Circumference and is a profile created from the resource Observation. Head Circumference relative is an observation concerning Head Circumference of a person's biological mother or father. Measuring this parameter helps doctors to predict the brain's growth and find any deviation. The profile is derived from the standard FHIR profile Head Circumference which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The profile ObservationHeadCircumferenceRelative is used for communicating an entry of a patient's relative's Head Circumference, by sending a value in the element observation.value.

Read Head Circumference for Relative

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.

Specific Rules and Limitations

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (Search)

Error Codes

In the table below, a few error messages specific for observations are listed.

Introduction

Cambio Core profile for communicating the vital sign, heart rate. Meant to be used as a base profile for more specific use case profiles.

Versions

Introduction

The ObservationHeartRateLite profile represents the vital sign Heart rate and is a profile created from the resource Observation. The vital sign heart rate holds a value of the patient pulse. The profile is derived from the standard FHIR profile Vital Signs which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The ObservationHeartRateLite is used for communicating the value of the patient's heart rate in beats per minutes by sending a value in the element observation.value. If the heart rate of the patient is irregular it can also be communicated using the extension element.

The API can be used to create and read patient heart rate information from/to COSMIC.

Create Heart Rate

Patient Generated

• The patient generated data is ordered by a care giver and there should be a responsible unit sent together with the data.

Healthcare Professional

• To create data using this API, the user should be a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment, and be connected, to the specified care unit. The care unit should also be specified with a HSA ID.
• The intended use is in first hand that the API is used within the same caregiver. The user and the specified care unit should exist in COSMIC as well as in the external system.

Read Heart Rate

• The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between caregivers, patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Extensions

Versions

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient= (Search)
2. GET [baseURL]/Observation/_search?status= (Search)
3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (Search)
4. GET [baseURL]/Observation/_search?_profile= (Search)
5. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (Search)
6. GET [baseURL]/Observation/_search?status=[status]&_include=[] (Search)
7. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[] (Search)
8. GET [baseURL]/Observation/_search?_profile=[url]&_include=[] (Search)
9. POST [baseURL]/Observation (Post)

Supported _include params

Observation:performer

Error Codes

In the table below, a few error messages specific for Observation are listed.

Introduction

The ObservationInspiredOxygenLite profile represents the inspired oxygen of the patient in relation to the saturation. The profile is created from the resource Observation.

Intended Use

The ObservationInspiredOxygenLite is used for communicating if the patient has received oxygen or not. It is only used in relation to the ObservationOxygenSaturationLite. The profile should therefore only be used as a contained resource.

If this profile is included in the payload of the Oxygen saturation, it should be interpreted as if the patient has received oxygen. The flow rate of the inspired oxygen is sent in the Observation.value element. It is optional.

ObservationInspiredOxygenLite is only used as a part of the Oxygen saturation API.

Supported Operations

No supported operations since this profile is only used as a contained resource.

Cambio Core profile for communicating the LeftTesticularVolume. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationLeftTesticularVolumeLite profile represents the parameter Left testicular volume and is a profile created from the resource Observation which makes the profile compliant with the FHIR standardized way of communicating vital sign data. Left testicular volume is an observation to record the volume of the left testicle, measured in milliliters.

Intended Use

The profile Left testicular volume is used for communicating the volume of the left testicle, measured in milliliters, by sending a value in the element observation.value.

Read Left Testicular Volume

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (search)

Error Codes

In the table below, a few error messages specific for observations are listed.

Cambio Core profile for communicating the Length of getation at. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationLengthOfGestationAtBirthLite profile represents the parameter Length Of Gestation At Birth and is a profile created from the resource Observation which makes the profile compliant with the FHIR standardized way of communicating vital sign data. Length Of Gestation At Birth is an observation of estimated fetus gestational age at delivery, measured in weeks (eg. 36 weeks and 4 days)

Intended Use

The profile ObservationLengthOfGestationAtBirthLite is used for communicating an entry of a patient's estimated fetus gestational age at delivery, by sending a value in the element observation.value.

Read Length of Gestation at Birth

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (search)

Error Codes

In the table below, a few error messages specific for observations are listed.

Introduction

The ObservationMicrobiology profile represents the result information of a microbiology request and is a profile created from the resource Observation. The Resistance results will not be shown using this Observation profile, only the results of other microbiology examinations done on the sample of the patient. The data available from COSMIC to this profile is only starting from R8.3.03 COSMIC release, information created before this release cannot be taken from this API.

Intended Use

The profile ObservationMicrobiology is used for communicating an entry of a result of a microbiology test done by sending a value in the element observation.value. This profile is referenced in the basedOn field of DiagnosticReport FHIR profile. The API can be used to read result information for a specific microbiology test done as a part of a microbiology.

Organization profile used for performer supports requesting PDL hierarchy details as well, it will have the full hierarchy of units related to performer.

Introduction

The ObservationMicrobiologyResistance profile represents the resistance results done for a microbiology sample and is a profile created from the resource Observation. Since there can be many resistance results for a result of a microbiology sample, this separate observation profile is used to record that information. The data available from COSMIC to this profile is only starting from R8.3.03 COSMIC release, information created before this release cannot be taken from this API.

Intended Use

The profile ObservationMicrobiologyResistance is used for communicating resistance test results done for a microbiology sample value in the element observation.value. The API can be used to read resistance results sent from a laboratory to COSMIC. This observation profile is linked to the ObservationMicrobiology profile using the hasMember field in the profile.

Versions

Introduction

The ObservationNews2Lite profile represents the Assessment scale NEWS2 and is a profile created from the resource Observation. The NEWS2 is a scale for the severity of a patients condition. The NEWS2 score is calculated by the vital signs of a patient.

Intended Use

The ObservationNews2Lite is used for communicating the severity of a patients condition by sending the calculated score in observation.value. The score should be between 0 and 20. The News2 profile should also contain references for all vital signs used to calculate the score. It is mandatory to send all the vital signs. The score(observation.value) is optional. In COSMIC the NEWS2 score is mapped to the internal archetype for NEWS2.

The API can be used to create, invalidate/remove and read patient NEWS2 information from/to COSMIC.

Create NEWS2

• To create data using this API, the user should be a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment, and be connected, to the specified care unit. The care unit should also be specified with a HSA ID.
• The intended use is in first hand that the API is used within the same caregiver. The user and the specified care unit should exist in COSMIC as well as in the external system.

Invalidate NEWS2

• If the external system is considered the master system of the information, it should be possible through the API to invalidate/delete the data in COSMIC, if it is invalidated/deleted in the master system.
• Invalidation of data should be done by a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment, and be connected, to the specified unit. The Unit should also be specified with a HSA ID. This is for traceability purposes and should be for the log.

Read NEWS2

• The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between caregivers, patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient= (search)
2. GET [baseURL]/Observation/_search?status= (search)
3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (search)
4. GET [baseURL]/Observation/_search?_profile= (search)
5. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (search)
6. GET [baseURL]/Observation/_search?status=[status]&_include=[] (search)
7. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[]
8. GET [baseURL]/Observation/_search?_profile=[url]&_include=[]
9. POST [baseURL]/Observation

Supported _include params

Observation:performer Observation.derivedFrom

Error Codes

In the table below, a few error messages specific for observations are listed.

Introduction

The ObservationONEWS2 profile represents the Assessment scale ONEWS2. ONEWS2 is a scale for the severity of a patients condition. The ONEWS2 score is calculated using the vital signs of a patient.
The intended use for ObservationONEWS2 is for communicating the severity of a patients condition by sending the calculated score in observation.value. The score should be between 0 and 24. The ONEWS2 profile should also contain references for all vital signs used to calculate the score. It is mandatory to send all the vital signs. The score (observation.value) is optional.

The API can be used to create and read ONEWS2 information to/from a Cambio system.

Note that invalidated observations will be returned as well (those with the status 'entered-in-error').

Must Support

The MustSupport-flag indicates which attributes are supported by Cambio, meaning that those can be returned as part of the ONEWS2 Observation.

Versions

Specific Rules and Limitations

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/[id]
2. POST [baseURL]/Observation

Error Codes

In the table below, a few error messages specific for observations are listed.

Cambio Core profile for communicating the vital sign, Saturation(SpO2). For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationOxygenSaturationLite profile represents the vital sign Oxygen Saturation and is a profile created from the resource Observation. The vital sign Oxygen Saturation holds a value of the blood saturation of the patient in percentage. It also contains a profile to state if the patient has received oxygen or not, and the flow rate of that potential oxygen (ObservationInspiredOxygenLite). The oxygen saturation profile is derived from the standard FHIR profile Vital Signs which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The ObservationOxygenSaturationLite is used for communicating the percentage of the patient blood saturation. The value is sent in the element observation.value. The profile can also hold information if the patient has a known hypercapnic respiratory failure. If the patient has received supplemental oxygen it can be communicated by including the contained profile for Inspired Oxygen in Observation.hasMember. If the InspiredOxygen profile is included it should be interpreted as if the patient has received oxygen.

The API can be used to create and read patient oxygen saturation information from/to COSMIC.

Create Oxygen Saturation

Patient Generated

• The patient generated data is ordered by a care giver and there should be a responsible unit sent together with the data.

Healthcare Professional

• To create data using this API, the user should be a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment, and be connected, to the specified care unit. The care unit should also be specified with a HSA ID.
• The intended use is in first hand that the API is used within the same caregiver. The user and the specified care unit should exist in COSMIC as well as in the external system.

Read Oxygen Saturation

• The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between caregivers, patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Extensions

Versions

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient= (Search)
2. GET [baseURL]/Observation/_search?status= (Search)
3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (Search)
4. GET [baseURL]/Observation/_search?_profile= (Search)
5. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (Search)
6. GET [baseURL]/Observation/_search?status=[status]&_include=[] (Search)
7. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[] (Search)
8. GET [baseURL]/Observation/_search?_profile=[url]&_include=[] (Search)
9. POST [baseURL]/Observation (Post)

Error Codes

In the table below, a few error messages specific for Observation are listed.

Cambio Core profile for communicating the level of pain using NRS scale For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationPainNrsLite profile represents the vital parameter Pain NRS and is a profile created from the resource Observation. Pain NRS is an observation concerning pain level based on a Numeric Rating Scale (NRS). This scale is used in healthcare to help assess the extent of a patient's pain, rated from 0 (no pain) to 10 (Worst pain). The profile is derived from the standard FHIR profile Vital Signs which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The ObservationPainNrsLite is used for communicating an entry of a patient's Pain NRS by sending a value in the element observation.value. The API can be used to create and read patient Pain NRS information from/to COSMIC.

Create Pain NRS

Patient Generated

• The patient generated data is ordered by a care giver and there should be a responsible unit sent together with the data.

Healthcare Professional

• Should be done by a healthcare professional with a specified HSA ID. This professional should have their assignment (medarbetaruppdrag) and be connected to the specified unit. The unit should also be specified with HSA ID. Intended use is in first hand that the API is used within the same care giver. The user and specified unit should exist in COSMIC and be the same in the external system.

Read Pain NRS

• The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between caregivers, patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient= (Search)
2. GET [baseURL]/Observation/_search?status= (Search)
3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (Search)
4. GET [baseURL]/Observation/_search?_profile= (Search)
5. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (Search)
6. GET [baseURL]/Observation/_search?status=[status]&_include=[] (Search)
7. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[] (Search)
8. GET [baseURL]/Observation/_search?_profile=[url]&_include=[] (Search)
9. POST [baseURL]/Observation (Post)

Error Codes

In the table below, a few error messages specific for Observation are listed.

Cambio Core profile for communicating the Pubic Hair Stage. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationPubicHairStageLite profile represents the parameter Pubic hair stage and is a profile created from the resource Observation which makes the profile compliant with the FHIR standardized way of communicating vital sign data. Pubic hair stage an observation to state the visible stages (tanner stage) of puberty by determining the degree of development of pubic hair.

Intended Use

The profile ObservationPubicHairStageLite is used for communicating the visible stages (tanner stage) of puberty by determining the degree of development of pubic hair, by sending a value in the element observation.value.

Read Pubic Hair Stage

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (search)

Error Codes

In the table below, a few error messages specific for observations are listed.

Introduction

The ObservationRadiology profile represents results in a radiology report (represented by the DiagnosticReportRadiology profile) and is a profile created from the resource Observation.

Intended Use

The ObservationRadiology profile is used inside the results section of the diagnostic report for radiology. For a specific radiology request all the results related to that request will be sent using this profile as observations. Retrieving the results without the diagnostic report is not supported for now.

For more in-depth intended and non-intended use cases, see radiology in the section Use Cases.

Specific Rules and Limitations

Versions

HTTP Methods

Cambio Core profile for communicating the vital sign, Respiratory rate. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationRespiratoryRateLite profile represents the vital parameter respiratory rate and is a profile created from the resource Observation. The vital sign RespiratoryLite holds a value of the respiratory rate in breaths per minute. The profile is derived from the standard FHIR profile Vital Signs which makes the profile compliant with the FHIR standardized way of communicating vital sign data.

Intended Use

The ObservationRespiratoryRateLite is used for communicating the breaths per minute of the patient. The value is sent in the element observation.value.

The API can be used to create and read patient respiratory rate information from/to COSMIC.

Create Respiratory Rate

Patient Generated

• The patient generated data is ordered by a care giver and there should be a responsible unit sent together with the data.

Healthcare Professional

• To create data using this API, the user should be a healthcare professional with a specified HSA ID. The healthcare professional should have their assignment, and be connected, to the specified care unit. The care unit should also be specified with a HSA ID.
• The intended use is in first hand that the API is used within the same caregiver. The user and the specified care unit should exist in COSMIC as well as in the external system.

Read Respiratory Rate

• The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between caregivers, patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Observation/_search?patient= (Search)
2. GET [baseURL]/Observation/_search?status= (Search)
3. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date] (Search)
4. GET [baseURL]/Observation/_search?_profile= (Search)
5. GET [baseURL]/Observation/_search?patient=&_include=Observation:performer (Search)
6. GET [baseURL]/Observation/_search?status=[status]&_include=[] (Search)
7. GET [baseURL]/Observation/_search?date=[gt_date]&date=[lt_date]&_include=[] (Search)
8. GET [baseURL]/Observation/_search?_profile=[url]&_include=[] (Search)
9. POST [baseURL]/Observation (Post)

Supported _include params

Observation:performer

Error Codes

In the table below, a few error messages specific for Observation are listed.

Cambio Core profile for communicating the Right Testicular Volume. For Use case specific profiles, this profile can be derived for the use case profile to be compliant with the Cambio core profile.

Introduction

The ObservationRightTesticularVolumeLite profile represents the parameter Right testicular volume and is a profile created from the resource Observation which makes the profile compliant with the FHIR standardized way of communicating vital sign data. Right testicular volume is an observation to record the volume of the right testicle, measured in milliliters.

Intended Use

The profile Right testicular volume is used for communicating the volume of the right testicle, measured in milliliters, by sending a value in the element observation.value.

Read Right Testicular Volume

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (search)

Error Codes

In the table below, a few error messages specific for observations are listed.

Cambio Core profile for communicating the Waist Circumference. For Use case specific profiles, this profile can be derived for the use case profile to be complient with the Cambio core profile.

Introduction

The ObservationWaistCircumferenceLite profile represents the parameter Waist circumference and is a profile created from the resource Observation which makes the profile compliant with the FHIR standardized way of communicating vital sign data. Waist circumference is an observation where a measurement taken around the abdomen at the level of the umbilicus (belly button).

Intended Use

The profile ObservationWaistCircumferenceLite is used for communicating an entry of a patient's measurement taken around the abdomen at the level of the umbilicus (belly button), by sending a value in the element observation.value.

Read Waist Circumference

• Intended use is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for copying inbetween care givers patient consent must be handled outside the API.
• Note that invalidated observations will be returned as well (those with the status 'entered-in-error'), unless filtered by status.

Specific Rules and Limitations

Versions

Supported Operations

Query Operations

Supported Queries

1. GET [baseURL]/Observation/_search?patient=&code= (search)

Error Codes

In the table below, a few error messages specific for observations are listed.

The OncologyMedicationDispense FHIR API is used to receive Medication Dispense related data from external pharmacy system which is specialized in cancer related drug preparations.Each MedicationDispense resource represents a single medication administration occasion. This profile is based on the FHIR resource MedicationDispense.

Intended Use

This profile is intended to be used for the posting of data related to a dispensing occasion of cancer related drugs to a patient.

Versions

Statuses

APIs & Supported Operations

Supported Queries

1. POST [baseURL]/MedicationDispense

Introduction

The operation $linkToHealthIssue is an operation performed on the profile QuestionnaireResponseSe, which is based on the QuestionnaireResponse resource. This operation is used to link a ConditionHealthIssueSe to the QuestionnaireResponseSe.

The formal computable definition of the operation is specified by the OperationDefinitionLinkToHealthIssue profile, derived from the OperationDefinition resource in FHIR R4.

To pass information into the operation, the ParametersHealthIssueReferenceSe profile is used, which is based on the Parameters resource in FHIR R4.

Intended Use

The API is designed to link a ConditionHealthIssueSe to a QuestionnaireResponseSe belonging to the same patient. Only one ConditionHealthIssueSe can be linked to a QuestionnaireResponseSe at a time. Additionally, only ConditionHealthIssueSe resources with an active or closed status can be linked.

The literal ID (COSMIC resource ID) of the QuestionnaireResponseSe to be linked must be provided in the API path. This ensures that the QuestionnaireResponseSe referenced exists in COSMIC.

The literal ID (COSMIC resource ID) of the ConditionHealthIssueSe to be linked should be included in the API request body using the ParametersHealthIssueReferenceSe profile.

This API is recommended for use by healthcare professionals.

Specific Rules and Limitations

Versions

Supported Operations

Input Parameters

• Path parameters: The literal ID of the QuestionnaireResponse
• Body parameters: The literal ID of the ConditionHealthIssueSe to be linked via the ParametersHealthIssueReferenceSe profile

Supported Queries

1. POST [baseURL]/QuestionnaireResponse/{id}/$linkToHealthIssue

Response Codes

Introduction

The operation $unlinkFromHealthIssue is an operation performed on the profile QuestionnaireResponseSe, which is based on the QuestionnaireResponse resource. This operation is used to disconnect the link between a ConditionHealthIssueSe and a QuestionnaireResponseSe.

The formal computable definition of the operation is specified by the OperationDefinitionUnlinkFromHealthIssue profile, derived from the OperationDefinition resource in FHIR R4.

To pass information into the operation, the ParametersHealthIssueReferenceSe profile is used, which is based on the Parameters resource in FHIR R4.

Intended Use

The API is designed to disconnect the link between a ConditionHealthIssueSe and a QuestionnaireResponseSe belonging to the same patient. Only one ConditionHealthIssueSe can be unlinked from a QuestionnaireResponseSe at a time.

The literal ID (COSMIC resource ID) of the QuestionnaireResponseSe to be unlinked must be provided in the API path. This ensures that the QuestionnaireResponseSe referenced exists in COSMIC.

The literal ID (COSMIC resource ID) of the ConditionHealthIssueSe to be unlinked must be included in the API request body using the ParametersHealthIssueReferenceSe profile.

This API is recommended for use by healthcare professionals.

Specific Rules and Limitations

Versions

Supported Operations

Input Parameters

• Path parameters: The literal ID of the QuestionnaireResponse
• Body parameters: The literal ID of the ConditionHealthIssueSe to be unlinked via the ParametersHealthIssueReferenceSe profile

Supported Queries

1. POST [baseURL]/QuestionnaireResponse/{id}/$unlinkFromHealthIssue

Response Codes

Introduction

The operation $invalidate is an operation performed on the profile EncounterOutpatientReadSe. This operation is used to invalidate an encounter that has been created in error. An example scenario is if the encounter was created for the wrong patient, meaning it should never have been valid.
The formal computable definition of the operation is specified by this profile.

Supported Operations

Input Parameters

• Path parameters: The literal id of the Encounter.
• Body parameters: The versionId of the Encounter and a textual representation of the reason for invalidating the Encounter.

For example of input parameters, see: InvalidateEncounterParametersExample

Supported Queries

1. POST [baseURL]/Encounter/{id}/$invalidate

Introduction

This is a light weight Swedish healthcare Organization profile. It can be used when Organizations have been referenced by other resources, such as Observation, ServiceRequest or Appointment. It can also be used for presenting a list of organizations with associated information.

Note that this profile is not maintained by Cambio, but is created in a Swedish vendor FHIR collaboration. Link to ImplementationGuide for the collaborative profiles will be added here shortly.

Intended Use

Intended use for this API is to get information about a healthcare organization, including units. The profile includes an extension which supports finding out the HSA care provider and HSA care unit for the specific organization. Following partOf reference can also be used to retrieve information about the whole organizational tree.

The profile is also referenced as target profile from many other resources enabling possibility to e.g. find PDL units connected to a certain resource, e.g. ServiceRequest or Organization. More information about this can be found on other resources in this ImplementationGuide.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Versions

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Organization/[id] (get by id)
2. GET [baseURL]/Organization/_search?identifier=[identifier] (Search)
3. GET [baseURL]/Organization/_search?name[name]= (Search)
4. GET [baseURL]/Organization/_search?_id=[id1],[id2],[id3] (Search)
5. GET [baseURL]/Organization/_search?_profile=[url] (Search)
6. POST [baseURL]/Organization (Post)
7. PUT [baseURL]/Organization (Put)

Supported _include params

1. partOf

This profile is intended to support transfer of information into the operations '$linkToHealthIssue' and '$unlinkFromHealthIssue'. These operations are used to create links and remove links between a QuestionnaireResponse and a ConditionHealthIssue, respectively.

This is a Core profile, hence is open in its profiling. Consider using more specific profiles derived from this one.

Introduction

PatientLiteSe is a profile based on the FHIR resource Patient.

Intended Use

The intended use for the PatientLiteSe profile is used to search for a list of patients based on a search parameter.

PatientLiteSe is defined for the Swedish market.

Specific Rules and Limitations

Versions

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Patient/_search?given=test
2. GET [baseURL]/Patient/_search?family=test

Error Codes

In below table, a few error messages specific for Patient are listed.

Introduction

PatientSe is a profile based on the FHIR resource Patient.

Intended Use

The PatientSe profile is used to retrieve demographic and administrative information about an individual receiving care or other health-related services. The PatientSe profile is profiled for the Swedish market.

Specific Rules and Limitations

Versions

Extensions

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Patient/_search?given=test
2. GET [baseURL]/Patient/_search?family=test
3. GET [baseURL]/Patient/_search?identifier=urn:oid:1.2.752.129.2.1.3.1|191212121212

Error Codes

In below table, a few error messages specific for Patient are listed.