Recare Search FHIR Implementation Guide
0.1.0 - ci-build
Recare Search FHIR Implementation Guide
0.1.0 - ci-build
Recare Search FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define constraints on FHIR resources for systems conforming to this implementation guide.
| Recare Care Level |
Care level observation as emitted in Recare search and admissions bundles (Basis-DE observation-de-pflegegrad). |
| Recare Care Provider |
Care provider Organization as used in Admissions API event bundles (ISiP Organization). Carries the IK-number and Recare-internal provider ID. |
| Recare Decrypted Data |
Inner bundle that is encrypted and carried as a Binary within the RecarePatientRequestEvent. Contains the patient's personal and clinical data. |
| Recare Encrypted Data |
Binary resource containing AES-encrypted patient data. The data field holds a base64-encoded ciphertext that, when decrypted with the key from the corresponding RecareEncryptedSecrets Binary, yields a FHIR Bundle with the patient's personal and clinical data. |
| Recare Encrypted Secrets |
Binary resource containing encrypted key material. The data field holds a base64-encoded RSA-OAEP encrypted AES key that API consumers use to decrypt the corresponding RecareEncryptedData Binary. |
| Recare Free Text Diagnosis |
Condition resource used in Admissions API bundles to represent a patient's diagnosis as free text. Not compliant with ISiK — no coded concept is required. |
| Recare Guardian |
Related person (guardian or family member) who acts as the requester for a patient in Admissions API bundles (ISiP Angehöriger). Also claims compliance with ISiKAngehoeriger in meta.profile. |
| Recare Other Insurance |
Other or unknown insurance type. |
| Recare Patient |
Patient as emitted in Recare event bundles (ISiP Pflegeempfaenger). Used in both the Receiver API (search bundles) and the Admissions API. |
| Recare Patient Request |
ServiceRequest representing a patient-initiated care request in the Admissions API. Not compliant with RecareSearch — this is a separate profile. |
| Recare Patient Request Event |
Event bundle for patient-initiated care requests in the Admissions API. Contains a RecarePatientRequest ServiceRequest, optional CareLevel observation, insurance coverage, and care provider organization. Encrypted patient data is carried in Binary entries. |
| Recare Private Health Insurance |
Private health insurance, does not contain the insurance company name. |
| Recare Statutory Health Insurance |
Statutory health insurance, does not contain the insurance company name. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Recare Care Provider Identifier |
Identifier profile for the Recare-internal care provider ID. Used to discriminate the CareproviderId slice in RecareCareProvider, consistent with ISiP's conformsTo() slicing pattern. |
| Recare Careprovider ID Identifier |
Identifier profile for Recare careprovider IDs. |
| Recare Request ID Identifier |
Identifier profile for Recare careprovider request IDs. |
| Recare Search User ID Identifier |
Identifier profile for Recare search user IDs. |
These define sets of codes used by systems conforming to this implementation guide.
| Recare Admissions Care Type |
Subset of care type codes used in the Admissions API ServiceRequest.code to indicate the desired type of inpatient care. |
| Recare Care Service |
All codes from the Recare Care Service code system, used in ServiceRequest.orderDetail to indicate outpatient care services requested. |
| Recare Current Care Type |
Subset of care type codes used in the Admissions API ServiceRequest.orderDetail to indicate the patient's current care situation. |
| Recare Patient Infection Status |
All codes from the Recare Patient Infection Status code system, used in ServiceRequest.orderDetail. |
| Recare Patient Mental Assessment |
All codes from the Recare Patient Mental Assessment code system, used in ServiceRequest.orderDetail. |
| Recare Patient Mobility Assessment |
All codes from the Recare Patient Mobility Assessment code system, used in ServiceRequest.orderDetail. |
| Recare Patient Request Reason |
All codes from the Recare Patient Request Reason code system, used in ServiceRequest.reasonCode. |
| Recare Patient Special Care Needs Assessment |
All codes from the Recare Patient Special Care Needs Assessment code system, used in ServiceRequest.orderDetail. |
| Recare Request Type |
All codes from the Recare Request Type code system, distinguishing the origin of a ServiceRequest. |
| Recare Transfer Type |
Allowed set of Recare transfer/search categories (care/hospital/rehabilitation/etc). |
| Typ der Einrichtung |
Local pre-built expansion of KBV_VS_MIO_ULB_Type_Of_Facility. Provided because the ValueSet pins SNOMED CT to edition 900000000000207008/version/20220331 which tx.fhir.org no longer hosts. The SNOMED codes are from the international edition and have not changed. |
These define new code systems used by systems conforming to this implementation guide.
| Recare Care Service |
Recare internal codes for the type of outpatient care services requested (Admissions API). |
| Recare Care Type |
Recare internal codes for care/search solution types. Codes are derived from SolutionValue.StringFhirEnglishV2() in the matching repository. |
| Recare Current Care Type |
Codes indicating the patient's current care situation at the time of a care request in the Admissions API. |
| Recare Event Type |
Recare internal codes identifying the type of webhook event carried in a Bundle. |
| Recare Patient Infection Status |
Recare internal codes for indicating a patient's infection status (Admissions API). |
| Recare Patient Mental Assessment |
Recare internal codes for assessing a patient's mental/cognitive status (Admissions API). |
| Recare Patient Mobility Assessment |
Recare internal codes for assessing a patient's mobility level (Admissions API). |
| Recare Patient Request Reason |
Recare internal codes for the reason behind a patient-initiated care request (Admissions API). |
| Recare Patient Special Care Needs Assessment |
Recare internal codes for assessing a patient's special care needs (Admissions API). |
| Recare Request Type |
Distinguishes the origin of a ServiceRequest in the Recare platform. |
| Recare Transfer Type |
Recare internal codes for search/transfer categories. Codes are derived from PatientTypeValue.StringFhirEnglish() in the matching repository. |
| SNOMED CT KBV Supplement (version 20220331) |
Local fragment of SNOMED CT edition 900000000000207008 version 20220331, containing codes referenced by KBV MIO ULB ValueSets. Provided because tx.fhir.org does not host this SNOMED CT version. Covers KBV_VS_MIO_ULB_Type_Of_Facility codes used in IsipOrganization.type binding. |
These define identifier and/or code system identities used by systems conforming to this implementation guide.
| RecareCareproviderID |
Identifier system used for careprovider identifiers in FHIR resources produced by Recare. Used as Identifier.system for careprovider IDs. |
| RecareRequestId |
Identifier system used for request identifiers in FHIR resources produced by Recare. Used as Identifier.system for careprovider request IDs. |
| RecareSearchId |
Identifier system used for search identifiers in FHIR resources produced by Recare. Used as Identifier.system for search IDs. |
| RecareSearchUserId |
Identifier system used for user/patient identifiers in FHIR resources produced by Recare. Used as Identifier.system for search user IDs. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| Example: Care Level (Observation) |
Patient care level 3 observation. Both optional notes are included: expedited processing flag and care level increase request. |
| Example: Care Provider (Organization) |
Nursing home care provider with IK-number and Recare-internal care provider ID. Compliant with ISiP Organization. |
| Example: Decrypted Data Bundle |
Inner bundle (after decryption) containing Patient, Guardian (optional), and free-text Diagnosis (optional). All three entries are populated in this example. |
| Example: Encrypted Data (Binary) |
Encrypted payload of the RecareDecryptedData bundle. contentType is base64Binary. data is a base64-encoded placeholder. Decrypt using the Secrets Binary. |
| Example: Encrypted Secrets (Binary) |
Encrypted key material used to decrypt the encrypted data Binary. contentType is base64Binary. data is a base64-encoded placeholder. |
| Example: Free Text Diagnosis (Condition) |
Patient-reported diagnosis as free text. clinicalStatus and verificationStatus are fixed by the profile. code.text carries the multi-line user input. |
| Example: Guardian (RelatedPerson) |
Spouse acting as requester on behalf of the patient. Contains name, telecom (as requester), relationship, and patient reference. |
| Example: Other Insurance — Unknown (Coverage) |
Other/unknown coverage for an Admissions API patient request. Insurance type and payor identity are not available. |
| Example: Patient (RecarePatient) |
Patient for an inpatient care request. Contains identifier, name, gender, birthDate, address, telecom, and managingOrganization. |
| Example: Patient Request (ServiceRequest) |
Patient-initiated inpatient care request. All required fields and all 6 orderDetail slices are populated. Guardian is the requester. |
| Example: Patient Request Event Bundle |
Outer event bundle for a patient-initiated inpatient care request. All 6 entries populated. Patient data is encrypted in the Binary entry. |
| Example: Private Health Insurance — PKV (Coverage) |
PKV coverage for an Admissions API patient request. Payor identity is not available; data-absent-reason extension is applied. |
| Example: Statutory Health Insurance — GKV (Coverage) |
GKV coverage for an Admissions API patient request. Payor identity is not available; data-absent-reason extension is applied. |