Linked Care Implementation Guide
0.9.1 - ci-build
Linked Care Implementation Guide
0.9.1 - ci-build
Linked Care Implementation Guide - Local Development build (v0.9.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Hostname | Description |
|---|---|
| fhir5-d.linkedcare.at | Development cluster gateway |
| fhir5-q.linkedcare.at | Q/A cluster gateway |
| (to be defined) | Production cluster gateway |
All REST endpoints will return the usual range of http status codes back to the client. Implementations should guarantee, that in case of http status code 400 Bad Request and also in case of http status code Conflict, the response body will contain an OperationOutcome resource with details about the error. There is also one case where the response body will contain an OperationOutcome even though the http status code is 200 OK: Partially successful cancellation of order.
The LINCA implementation defines the following operation outcomes:
| Code | Message | Description |
|---|---|---|
| LCVAL01 | Name of patient (in field name.text) cannot be null | Enter a string into the name.text field of the patient resource |
| LCVAL02 | 'value' is no valid social security number | Provide a social security number which is valid according to the checksum rules of the national implementation |
| LCVAL03 | A patient can have at most one social security number | Provide at most one social security number in a patient record |
| LCVAL04 | birthDate is required when the social security number is missing | Enter a value into the field birthDate |
| LCVAL05 | The gender field must not be empty | Enter a value into the gender field |
| LCVAL06 | Cast of transmitted resource to Patient resource failed | Make sure the resource is well-formed and matches the profile of the national implementation |
| LCVAL07 | The intent field must not be empty | Enter a value into the intent field |
| LCVAL08 | The status field must not be empty | Enter a value into the status field |
| LCVAL09 | The subject field must not be empty | Enter a value (reference) into the subject field |
| LCVAL10 | 'value' in field intent is not valid in LINCARequestOrchestration | Enter a value that matches the rules of the present resource profile (e.g., 'proposal') |
| LCVAL11 | 'value' in field status is not valid in new LINCARequestOrchestration | Enter a value that matches the rules of the present resource profile (e.g., 'active') |
| LCVAL12 | The OID in field subject is not valid | Enter a value that is consistent with the OID in your authentication certificate |
| LCVAL13 | Cardinality violation in field contained: minimum is 1 inline resource | Add at least one inline MedicationRequest resource into the contained field |
| LCVAL14 | Cast of transmitted resource to RequestOrchestration resource failed | Make sure the resource is well-formed and matches the profile of the national implementation |
| LCVAL15 | The field id must be empty in contained resources | Remove the value from the field id. You can add your internal ids into the identifier field |
| LCVAL16 | The field basedOn must be empty contained resources | Remove any references from the field basedOn in contained MedicationRequest resources |
| LCVAL17 | value in field status is not valid in contained LINCAProposalMedicationRequest | Enter a value that matches the rules of the present resource profile (e.g., 'unknown') |
| LCVAL18 | The field basedOn must contain exactly one reference | Enter exactly one reference to an existing LINCA resource into the field basedOn |
| LCVAL19 | 'value' in field intent is not valid in LINCAProposalMedicationRequest | Enter a value that matches the rules of the present resource profile (e.g., 'proposal') |
| LCVAL20 | 'value' in field status is not valid in LINCAProposalMedicationRequest | Enter a value that matches the rules of the present resource profile (e.g., 'active') |
| LCVAL21 | The field priorPrescription must be empty in LINCAProposalMedicationRequest | The field priorPrescription shall only be filled by prescribing practitioners |
| LCVAL22 | The field groupIdentifier must be empty in LINCAProposalMedicationRequest | The field groupIdentifier is reserved for the eRezept-Id |
| LCVAL23 | The field informationSource must not be empty | Enter exactly one reference into the informationSource field |
| LCVAL24 | The OID in informationSource is not valid | Enter a value that is consistent with the OID in your authentication certificate |
| LCVAL25 | The field requester must not be empty | Enter a value into the field requester |
| LCVAL26 | The field medication must not be empty | Enter a value in the medication field |
| LCVAL27 | The provided refstring 'value' in field subject is no valid refstring | Enter a valid reference string in the field subject, e.g., 'HL7ATCorePatient/FhirIdOfPatient' |
| LCVAL28 | Patient reference in field subject not found | Enter the Fhir-Id of an existing HL7ATCorePatient resource |
| LCVAL29 | The field performer must not be empty | Enter a value in the performer field (the OID of the practitioner) |
| LCVAL30 | The OID in field performer is not valid | Enter a syntactically correct OID of an active and eligible physician |
| LCVAL31 | The reference in field basedOn is no valid refstring | Enter a valid reference string in the field basedOn, e.g., 'LINCAResource/FhirIdOfResource' |
| LCVAL32 | Referenced resource in field basedOn not found | Enter the Fhir-Id of an existing LINCA resource |
| LCVAL33 | Referenced resource in field basedOn is not the latest chain link | Always refer to the youngest link in a resource chain |
| LCVAL34 | The field informationSource must contain exactly one element | Enter exactly one reference into the informationSource field |
| LCVAL35 | Cast of transmitted resource to MedicationRequest resource failed | Make sure the resource is well-formed and matches the profile of the national implementation |
| LCVAL36 | Field supportingInformation cannot differ from referenced resource in field basedOn, priorPrescription, or authorizingPrescription | Remove the reference to LINCARequestOrchestration in field supportingInformation or copy it correctly from the referenced resource |
| LCVAL37 | Cardinality violation: field basedOn must contain at most one reference | Remove redundant references from the field basedOn |
| LCVAL38 | Reference required, either in field basedOn or in priorPrescription | Enter references correspondig to the rules of the present resource profile |
| LCVAL39 | The reference in field priorPrescription is no valid refstring | Enter a valid reference string in the field priorPrescription, e.g., 'LINCAResource/FhirIdOfResource' |
| LCVAL40 | Reference in field priorPrescription not found | Enter the Fhir-Id of an existing LINCA resource |
| LCVAL41 | Referenced resource in field priorPrescription is not the latest chain link | Always refer to the latest link in a resource chain |
| LCVAL42 | Field informationSource cannot differ from the referenced resource in basedOn or priorPrescription | Remove the reference from field informationSource or copy it correctly from the referenced resource |
| LCVAL43 | Field requester cannot differ from the referenced resource in basedOn or priorPrescription | Remove the reference from field requester or copy it correctly from the referenced resource |
| LCVAL44 | Field dispenser cannot differ from the referenced resource in basedOn or priorPrescription | Remove the reference from field dispenser or copy it correctly from the referenced resource |
| LCVAL45 | Field subject cannot differ from the referenced resource in basedOn or priorPrescription | Copy the patient reference correctly from the referenced resource |
| LCVAL46 | Field performer cannot differ from the referenced resource in basedOn or priorPrescription | Enter the correct performer OID into the field performer |
| LCVAL47 | The field intent shall be 'order' in this use case | Enter the proposed value in the field intent |
| LCVAL48 | Value in field status is not supported on this Fhir server | Enter a value that matches the rules of the present resource profile |
| LCVAL49 | Cast of transmitted resource to MedicationDispense resource failed | Make sure the resource is well-formed and matches the profile of the national implementation |
| LCVAL50 | Cardinality violation: field authorizingPrescription must contain exactly one reference | Enter a reference to a LINCAPrescriptionMedicationResource into the field authorizingPrescription |
| LCVAL51 | The reference in field authorizingPrescription is no valid refstring | Enter a valid reference string in the field authorizingPrescription, e.g., 'LINCAResource/FhirIdOfResource' |
| LCVAL52 | Reference in field authorizingPrescription not found | Enter the reference of an existing LINCA resource |
| LCVAL53 | Referenced resource in field authorizingPrescription is not the latest chain link | Always refer to the latest link in a resource chain |
| LCVAL54 | Value in field status must be 'completed' | Enter the required value into the status field |
| LCVAL55 | Exactly one performer is required and the field performer.identifier.value must contain the performers OID | Enter the required value into the field performer.identifier.value |
| LCVAL56 | The dispensers OID must be provided in dispenseRequest.dispenser.identifier.value | Enter the value into the field dispenseRequest.dispenser.identifier.value |
| LCVAL57 | The field performer.actor.identifier.value must contain the OID of the dispensing pharmacy | Enter the required value into the field performer.actor.identifier.value |
| LCVAL58 | Value 'value' in field intent is not supported on this Fhir server | Check the Linked Care Implementation Guide for allowed values of field intent |
| LCVAL59 | In field status the value 'active' is required in this use case | Enter the value 'active' into the field status |
| LCVAL60 | The field supportingInformation must contain a reference to the lc_id in adhoc prescriptions | Add the required reference to supportingInformation |
| LCVAL61 | Ad hoc prescriptions must refer to an existing proposal for the patient concerned | Make sure to enter an existing combination of patient reference and lc_id |
| LCVAL62 | Cancellation of proposal id 'value' failed | It has already been processed. |
| LCVAL63 | Cancellation of RequestOrchestration lc_id 'value' failed | It has already been revoked or completed |
| LCVAL64 | Contained resources must be referenced in field action.resource | Add a reference to the internal id of the contained resource |
| LCVAL65 | The OID in field dispenseRequest.dispenser is not valid | Enter a syntactically correct OID of an active pharmacy |
| LCVAL66 | The OID in field performer cannot differ from the OID in the sender's certificate | Enter the correct OID in field performer |
| LCVAL67 | The field priorPrescription must be empty when intent is set to 'originalOrder' | Either remove the reference in priorPrescription, or set the intent to 'order' |
| LCVAL68 | In a Bundle of LINCAPrescriptionMedicationRequests, all of them must refer to the same subject | Remove LINCAPrescriptionMedicationRequests with differing subject |
| LCVAL69 | In a Bundle of LINCAPrescriptionMedicationRequests, all of them must have the same groupIdentifier | Remove LINCAPrescriptionMedicationRequests with differing groupIdentifier |
| LCVAL70 | Genuine initial prescriptions cannot be connected to existing orders/lc_id | Remove the reference from supportingInformation |
| LCVAL71 | New and active prescriptions must be sent with [POST $prescription Bundle] | Check the Linked Care Implementation Guide, User Stories for Actor Doctor |
In addition to that, the base implementation defines standard validation outcomes as follows:
| Code | Message | Description |
|---|---|---|
| PVAL101 | Value is of type type, which is not an allowed choice | Mismatch between expected content and provided content |
| PVAL102 | Element has count elements, but minium cardinality is cardinality | Missing input or too few elements in a set with a defined minimum size |
| PVAL103 | Element has count elements, but maximum cardinality is cardinality | Input into a non-writable field or too many elements in a set with a defined maximum size |
| PVAL104 | Repeating elements should not contain a null value | A field which contains a set of elements, should be contiguous |
| PVAL105 | Element with minimum cardinality cardinality cannot be null | Missing input into a mandatory field |
| PVAL106 | 'value' is not a correct literal for a code | Malformed code value |
| PVAL107 | 'value' is not a correct literal for a date | Malformed date value |
| PVAL108 | 'value' is not a correct literal for a dateTime | Malformed datetime value |
| PVAL109 | 'value' is not a correct literal for an id | Malformed FhirId value |
| PVAL110 | Value is not well-formatted Xml: value | Invalid Xml document |
| PVAL111 | Value is not well-formed Xml adhering to the FHIR schema for Narrative: value | Invalid narrative content value |
| PVAL112 | 'value' is not a correct literal for an oid | Malformed OID value |
| PVAL113 | 'value' is not a correct literal for a time | Malformed time-of-day value |
| PVAL114 | 'value' is not a correct literal for an uri | Malformed URI value |
| PVAL115 | 'value' is not a correct literal for a uuid | Malformed UUID value |
| PVAL116 | Value 'value' is not a correct code for valueset 'valueset' | Not a valid value in the corresponding code system |
| PVAL117 | Resource has contained resources with narrative, which is not allowed | Resources in the "contained" field may not come with their own narrative |
| PVAL118 | It is not allowed for a resource to contain resources which themselves contain resources | There may be at most one level of "contained" nesting |