CodeSystem-eRS-APIErrorCode-1

HTML View

Concepts

This code system https://fhir.nhs.uk/STU3/CodeSystem/eRS-APIErrorCode-1 defines the following codes:

CodeDisplayDefinition
INVALID_VALUEInvalid value
INVALID_CODEInvalid code
MISSING_VALUEA mandatory input field is missing
CONFLICTING_VALUESConflicting values
UNEXPECTED_FIELDUnexpected field
INVALID_REQUEST_TYPEInvalid Request Type
INVALID_REQUEST_STATEInvalid Request State
PATIENT_SENSITIVEPatient Sensitive
NO_RELATIONSHIPNo Relationship
FHIR_CONSTRAINT_VIOLATIONFHIR constraint violated
DUPLICATE_FILENAMEThe Filename of one of the files that correspond to the IDs supplied exactly matches (including extension) that of an existing file already associated with the referral.
FIELD_NOT_PERMITTEDThis field, although expected by the operation, is not applicable in some cases due to business rules.
FILE_SIZE_ERRORThe file is either empty or too large.
INAPPROPRIATE_VALUEA value, which is acceptable under different conditions, is inappropriate in the context of the other information provided with the request.
INVALID_FHIR_STRUCTUREe-RS is unable to interpret the provided json as FHIR.
INVALID_STATEA referenced entity in an invalid state for the operation to proceed.
NO_ACCESSThe current user does not have permission to access one of the entities referenced.
NO_ACCESS_CODEThe patient record is missing the access code that is necessary to log onto Manage My Referrals
ORGANISATION_IS_CLOSEDThe selected organisation is marked as closed
ORGANISATION_NOT_APPROPRIATEThe selected organisation is of a type that is not suitable for the operation.
PATIENT_ERRORAn error occurred while fetching the patient's record from PDS.
REFERENCE_NOT_FOUNDAn entity referenced in the body of the request is not found when looked up.
REFERENCED_USER_IS_NOT_ACTIVEA user is not marked as active in SDS.
REFERENCED_USER_IS_NOT_RCThe referenced user doesn't have the Referring Clinician Role.
REFERENCED_USER_IS_NOT_SPCThe referenced user doesn't have the Service Provider Clinician Role.
REFERENCED_USER_NOT_IN_ORGThe referenced user is not in the required organisation.
SHORTLISTED_SERVICE_NOT_IN_RESULTSA service proposed for shortlisting is not compatible with the search criteria.
SNOMED_NOT_FOUNDA SNOMED code, while potentially valid in the latest version of the international dictionary, is not found in the e-RS copy of the dictionary.
TOO_MANY_ITEMSToo many items have been provided in an array or list.
VALUE_IS_REQUIREDThis fields, although defined as optional, is required in specific cases due to business rules.
PENDINGThe file is currently being scanned and cannot be retrieved.
THREATS_FOUNDThe file has been quarantined as a threats has been detected, the file cannot be retrieved.
VALIDATION_FAILEDThe file has failed validation.Reasons for this include: the file type provided is not supported or does not correlate with the file extension; the file is too large
FORBIDDENAn issue occurred whilst attempting to authorise a request
SYSTEM_UNAVAILABLEThere has been a processing failure in the request chain. This could be transient failure for a single request, a temporary service issue, maintenance window or due to an issue with a downstream service. Re-send the request after a period of time (using the value specified in the 'Retry-After' header if provided)

Table View

CodeSystem.url[0]https://fhir.nhs.uk/STU3/CodeSystem/eRS-APIErrorCode-1
CodeSystem.version[0]1.3.0
CodeSystem.name[0]eRS API Error Code
CodeSystem.status[0]active
CodeSystem.publisher[0]NHS Digital
CodeSystem.contact[0].name[0]Interoperability Team
CodeSystem.contact[0].telecom[0].system[0]email
CodeSystem.contact[0].telecom[0].value[0]interoperabilityteam@nhs.net
CodeSystem.contact[0].telecom[0].use[0]work
CodeSystem.purpose[0]Code system used to indicate the type of attachment
CodeSystem.copyright[0]2019 NHS Digital
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]INVALID_VALUE
CodeSystem.concept[0].display[0]Invalid value
CodeSystem.concept[1].code[0]INVALID_CODE
CodeSystem.concept[1].display[0]Invalid code
CodeSystem.concept[2].code[0]MISSING_VALUE
CodeSystem.concept[2].display[0]A mandatory input field is missing
CodeSystem.concept[3].code[0]CONFLICTING_VALUES
CodeSystem.concept[3].display[0]Conflicting values
CodeSystem.concept[4].code[0]UNEXPECTED_FIELD
CodeSystem.concept[4].display[0]Unexpected field
CodeSystem.concept[5].code[0]INVALID_REQUEST_TYPE
CodeSystem.concept[5].display[0]Invalid Request Type
CodeSystem.concept[6].code[0]INVALID_REQUEST_STATE
CodeSystem.concept[6].display[0]Invalid Request State
CodeSystem.concept[7].code[0]PATIENT_SENSITIVE
CodeSystem.concept[7].display[0]Patient Sensitive
CodeSystem.concept[8].code[0]NO_RELATIONSHIP
CodeSystem.concept[8].display[0]No Relationship
CodeSystem.concept[9].code[0]FHIR_CONSTRAINT_VIOLATION
CodeSystem.concept[9].display[0]FHIR constraint violated
CodeSystem.concept[10].code[0]DUPLICATE_FILENAME
CodeSystem.concept[10].display[0]The Filename of one of the files that correspond to the IDs supplied exactly matches (including extension) that of an existing file already associated with the referral.
CodeSystem.concept[11].code[0]FIELD_NOT_PERMITTED
CodeSystem.concept[11].display[0]This field, although expected by the operation, is not applicable in some cases due to business rules.
CodeSystem.concept[12].code[0]FILE_SIZE_ERROR
CodeSystem.concept[12].display[0]The file is either empty or too large.
CodeSystem.concept[13].code[0]INAPPROPRIATE_VALUE
CodeSystem.concept[13].display[0]A value, which is acceptable under different conditions, is inappropriate in the context of the other information provided with the request.
CodeSystem.concept[14].code[0]INVALID_FHIR_STRUCTURE
CodeSystem.concept[14].display[0]e-RS is unable to interpret the provided json as FHIR.
CodeSystem.concept[15].code[0]INVALID_STATE
CodeSystem.concept[15].display[0]A referenced entity in an invalid state for the operation to proceed.
CodeSystem.concept[16].code[0]NO_ACCESS
CodeSystem.concept[16].display[0]The current user does not have permission to access one of the entities referenced.
CodeSystem.concept[17].code[0]NO_ACCESS_CODE
CodeSystem.concept[17].display[0]The patient record is missing the access code that is necessary to log onto Manage My Referrals
CodeSystem.concept[18].code[0]ORGANISATION_IS_CLOSED
CodeSystem.concept[18].display[0]The selected organisation is marked as closed
CodeSystem.concept[19].code[0]ORGANISATION_NOT_APPROPRIATE
CodeSystem.concept[19].display[0]The selected organisation is of a type that is not suitable for the operation.
CodeSystem.concept[20].code[0]PATIENT_ERROR
CodeSystem.concept[20].display[0]An error occurred while fetching the patient's record from PDS.
CodeSystem.concept[21].code[0]REFERENCE_NOT_FOUND
CodeSystem.concept[21].display[0]An entity referenced in the body of the request is not found when looked up.
CodeSystem.concept[22].code[0]REFERENCED_USER_IS_NOT_ACTIVE
CodeSystem.concept[22].display[0]A user is not marked as active in SDS.
CodeSystem.concept[23].code[0]REFERENCED_USER_IS_NOT_RC
CodeSystem.concept[23].display[0]The referenced user doesn't have the Referring Clinician Role.
CodeSystem.concept[24].code[0]REFERENCED_USER_IS_NOT_SPC
CodeSystem.concept[24].display[0]The referenced user doesn't have the Service Provider Clinician Role.
CodeSystem.concept[25].code[0]REFERENCED_USER_NOT_IN_ORG
CodeSystem.concept[25].display[0]The referenced user is not in the required organisation.
CodeSystem.concept[26].code[0]SHORTLISTED_SERVICE_NOT_IN_RESULTS
CodeSystem.concept[26].display[0]A service proposed for shortlisting is not compatible with the search criteria.
CodeSystem.concept[27].code[0]SNOMED_NOT_FOUND
CodeSystem.concept[27].display[0]A SNOMED code, while potentially valid in the latest version of the international dictionary, is not found in the e-RS copy of the dictionary.
CodeSystem.concept[28].code[0]TOO_MANY_ITEMS
CodeSystem.concept[28].display[0]Too many items have been provided in an array or list.
CodeSystem.concept[29].code[0]VALUE_IS_REQUIRED
CodeSystem.concept[29].display[0]This fields, although defined as optional, is required in specific cases due to business rules.
CodeSystem.concept[30].code[0]PENDING
CodeSystem.concept[30].display[0]The file is currently being scanned and cannot be retrieved.
CodeSystem.concept[31].code[0]THREATS_FOUND
CodeSystem.concept[31].display[0]The file has been quarantined as a threats has been detected, the file cannot be retrieved.
CodeSystem.concept[32].code[0]VALIDATION_FAILED
CodeSystem.concept[32].display[0]The file has failed validation.
CodeSystem.concept[32].definition[0]Reasons for this include: the file type provided is not supported or does not correlate with the file extension; the file is too large
CodeSystem.concept[33].code[0]FORBIDDEN
CodeSystem.concept[33].display[0]An issue occurred whilst attempting to authorise a request
CodeSystem.concept[34].code[0]SYSTEM_UNAVAILABLE
CodeSystem.concept[34].display[0]There has been a processing failure in the request chain. This could be transient failure for a single request, a temporary service issue, maintenance window or due to an issue with a downstream service. Re-send the request after a period of time (using the value specified in the 'Retry-After' header if provided)

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
<url value="https://fhir.nhs.uk/STU3/CodeSystem/eRS-APIErrorCode-1" />
<version value="1.3.0" />
<name value="eRS API Error Code" />
<status value="active" />
<publisher value="NHS Digital" />
<contact>
<name value="Interoperability Team" />
<telecom>
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
</telecom>
</contact>
<purpose value="Code system used to indicate the type of attachment" />
<copyright value="2019 NHS Digital" />
<content value="complete" />
<concept>
<code value="INVALID_VALUE" />
<display value="Invalid value" />
</concept>
<concept>
<code value="INVALID_CODE" />
<display value="Invalid code" />
</concept>
<concept>
<code value="MISSING_VALUE" />
<display value="A mandatory input field is missing" />
</concept>
<concept>
<code value="CONFLICTING_VALUES" />
<display value="Conflicting values" />
</concept>
<concept>
<code value="UNEXPECTED_FIELD" />
<display value="Unexpected field" />
</concept>
<concept>
<code value="INVALID_REQUEST_TYPE" />
<display value="Invalid Request Type" />
</concept>
<concept>
<code value="INVALID_REQUEST_STATE" />
<display value="Invalid Request State" />
</concept>
<concept>
<code value="PATIENT_SENSITIVE" />
<display value="Patient Sensitive" />
</concept>
<concept>
<code value="NO_RELATIONSHIP" />
<display value="No Relationship" />
</concept>
<concept>
<code value="FHIR_CONSTRAINT_VIOLATION" />
<display value="FHIR constraint violated" />
</concept>
<concept>
<code value="DUPLICATE_FILENAME" />
<display value="The Filename of one of the files that correspond to the IDs supplied exactly matches (including extension) that of an existing file already associated with the referral." />
</concept>
<concept>
<code value="FIELD_NOT_PERMITTED" />
<display value="This field, although expected by the operation, is not applicable in some cases due to business rules." />
</concept>
<concept>
<code value="FILE_SIZE_ERROR" />
<display value="The file is either empty or too large." />
</concept>
<concept>
<code value="INAPPROPRIATE_VALUE" />
<display value="A value, which is acceptable under different conditions, is inappropriate in the context of the other information provided with the request." />
</concept>
<concept>
<code value="INVALID_FHIR_STRUCTURE" />
<display value="e-RS is unable to interpret the provided json as FHIR." />
</concept>
<concept>
<code value="INVALID_STATE" />
<display value="A referenced entity in an invalid state for the operation to proceed." />
</concept>
<concept>
<code value="NO_ACCESS" />
<display value="The current user does not have permission to access one of the entities referenced." />
</concept>
<concept>
<code value="NO_ACCESS_CODE" />
<display value="The patient record is missing the access code that is necessary to log onto Manage My Referrals" />
</concept>
<concept>
<code value="ORGANISATION_IS_CLOSED" />
<display value="The selected organisation is marked as closed" />
</concept>
<concept>
<code value="ORGANISATION_NOT_APPROPRIATE" />
<display value="The selected organisation is of a type that is not suitable for the operation." />
</concept>
<concept>
<code value="PATIENT_ERROR" />
<display value="An error occurred while fetching the patient's record from PDS." />
</concept>
<concept>
<code value="REFERENCE_NOT_FOUND" />
<display value="An entity referenced in the body of the request is not found when looked up." />
</concept>
<concept>
<code value="REFERENCED_USER_IS_NOT_ACTIVE" />
<display value="A user is not marked as active in SDS." />
</concept>
<concept>
<code value="REFERENCED_USER_IS_NOT_RC" />
<display value="The referenced user doesn't have the Referring Clinician Role." />
</concept>
<concept>
<code value="REFERENCED_USER_IS_NOT_SPC" />
<display value="The referenced user doesn't have the Service Provider Clinician Role." />
</concept>
<concept>
<code value="REFERENCED_USER_NOT_IN_ORG" />
<display value="The referenced user is not in the required organisation." />
</concept>
<concept>
<code value="SHORTLISTED_SERVICE_NOT_IN_RESULTS" />
<display value="A service proposed for shortlisting is not compatible with the search criteria." />
</concept>
<concept>
<code value="SNOMED_NOT_FOUND" />
<display value="A SNOMED code, while potentially valid in the latest version of the international dictionary, is not found in the e-RS copy of the dictionary." />
</concept>
<concept>
<code value="TOO_MANY_ITEMS" />
<display value="Too many items have been provided in an array or list." />
</concept>
<concept>
<code value="VALUE_IS_REQUIRED" />
<display value="This fields, although defined as optional, is required in specific cases due to business rules." />
</concept>
<concept>
<code value="PENDING" />
<display value="The file is currently being scanned and cannot be retrieved." />
</concept>
<concept>
<code value="THREATS_FOUND" />
<display value="The file has been quarantined as a threats has been detected, the file cannot be retrieved." />
</concept>
<concept>
<code value="VALIDATION_FAILED" />
<display value="The file has failed validation." />
<definition value="Reasons for this include: the file type provided is not supported or does not correlate with the file extension; the file is too large" />
</concept>
<concept>
<code value="FORBIDDEN" />
<display value="An issue occurred whilst attempting to authorise a request" />
</concept>
<concept>
<code value="SYSTEM_UNAVAILABLE" />
<display value="There has been a processing failure in the request chain. This could be transient failure for a single request, a temporary service issue, maintenance window or due to an issue with a downstream service. Re-send the request after a period of time (using the value specified in the 'Retry-After' header if provided)" />
</concept>
</CodeSystem>

JSON View

{
"resourceType": "CodeSystem",
"url": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-APIErrorCode-1",
"version": "1.3.0",
"name": "eRS API Error Code",
"status": "active",
"publisher": "NHS Digital",
"contact": [
{
"name": "Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work"
}
]
}
],
"purpose": "Code system used to indicate the type of attachment",
"copyright": "2019 NHS Digital",
"content": "complete",
"concept": [
{
"code": "INVALID_VALUE",
"display": "Invalid value"
},
{
"code": "INVALID_CODE",
"display": "Invalid code"
},
{
"code": "MISSING_VALUE",
"display": "A mandatory input field is missing"
},
{
"code": "CONFLICTING_VALUES",
"display": "Conflicting values"
},
{
"code": "UNEXPECTED_FIELD",
"display": "Unexpected field"
},
{
"code": "INVALID_REQUEST_TYPE",
"display": "Invalid Request Type"
},
{
"code": "INVALID_REQUEST_STATE",
"display": "Invalid Request State"
},
{
"code": "PATIENT_SENSITIVE",
"display": "Patient Sensitive"
},
{
"code": "NO_RELATIONSHIP",
"display": "No Relationship"
},
{
"code": "FHIR_CONSTRAINT_VIOLATION",
"display": "FHIR constraint violated"
},
{
"code": "DUPLICATE_FILENAME",
"display": "The Filename of one of the files that correspond to the IDs supplied exactly matches (including extension) that of an existing file already associated with the referral."
},
{
"code": "FIELD_NOT_PERMITTED",
"display": "This field, although expected by the operation, is not applicable in some cases due to business rules."
},
{
"code": "FILE_SIZE_ERROR",
"display": "The file is either empty or too large."
},
{
"code": "INAPPROPRIATE_VALUE",
"display": "A value, which is acceptable under different conditions, is inappropriate in the context of the other information provided with the request."
},
{
"code": "INVALID_FHIR_STRUCTURE",
"display": "e-RS is unable to interpret the provided json as FHIR."
},
{
"code": "INVALID_STATE",
"display": "A referenced entity in an invalid state for the operation to proceed."
},
{
"code": "NO_ACCESS",
"display": "The current user does not have permission to access one of the entities referenced."
},
{
"code": "NO_ACCESS_CODE",
"display": "The patient record is missing the access code that is necessary to log onto Manage My Referrals"
},
{
"code": "ORGANISATION_IS_CLOSED",
"display": "The selected organisation is marked as closed"
},
{
"code": "ORGANISATION_NOT_APPROPRIATE",
"display": "The selected organisation is of a type that is not suitable for the operation."
},
{
"code": "PATIENT_ERROR",
"display": "An error occurred while fetching the patient's record from PDS."
},
{
"code": "REFERENCE_NOT_FOUND",
"display": "An entity referenced in the body of the request is not found when looked up."
},
{
"code": "REFERENCED_USER_IS_NOT_ACTIVE",
"display": "A user is not marked as active in SDS."
},
{
"code": "REFERENCED_USER_IS_NOT_RC",
"display": "The referenced user doesn't have the Referring Clinician Role."
},
{
"code": "REFERENCED_USER_IS_NOT_SPC",
"display": "The referenced user doesn't have the Service Provider Clinician Role."
},
{
"code": "REFERENCED_USER_NOT_IN_ORG",
"display": "The referenced user is not in the required organisation."
},
{
"code": "SHORTLISTED_SERVICE_NOT_IN_RESULTS",
"display": "A service proposed for shortlisting is not compatible with the search criteria."
},
{
"code": "SNOMED_NOT_FOUND",
"display": "A SNOMED code, while potentially valid in the latest version of the international dictionary, is not found in the e-RS copy of the dictionary."
},
{
"code": "TOO_MANY_ITEMS",
"display": "Too many items have been provided in an array or list."
},
{
"code": "VALUE_IS_REQUIRED",
"display": "This fields, although defined as optional, is required in specific cases due to business rules."
},
{
"code": "PENDING",
"display": "The file is currently being scanned and cannot be retrieved."
},
{
"code": "THREATS_FOUND",
"display": "The file has been quarantined as a threats has been detected, the file cannot be retrieved."
},
{
"code": "VALIDATION_FAILED",
"display": "The file has failed validation.",
"definition": "Reasons for this include: the file type provided is not supported or does not correlate with the file extension; the file is too large"
},
{
"code": "FORBIDDEN",
"display": "An issue occurred whilst attempting to authorise a request"
},
{
"code": "SYSTEM_UNAVAILABLE",
"display": "There has been a processing failure in the request chain. This could be transient failure for a single request, a temporary service issue, maintenance window or due to an issue with a downstream service. Re-send the request after a period of time (using the value specified in the 'Retry-After' header if provided)"
}
]
}
---
back to top