HIP FHIR Common Terminology Guide
1.9.2 - Release
HIP FHIR Common Terminology Guide
1.9.2 - Release
Publication Build: This will be filled in by the publication tooling
| Active as of 2017-09-01 |
{
"resourceType" : "CodeSystem",
"id" : "hip-error-code",
"meta" : {
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/shareablecodesystem"
]
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem hip-error-code</b></p><a name=\"hip-error-code\"> </a><a name=\"hchip-error-code\"> </a><a name=\"hip-error-code-en-US\"> </a><p>This case-insensitive code system <code>https://standards.digital.health.nz/ns/hip-error-code</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td></tr><tr><td style=\"white-space:nowrap\">EM02002<a name=\"hip-error-code-EM02002\"> </a></td><td>Cannot be found</td></tr><tr><td style=\"white-space:nowrap\">EM02004<a name=\"hip-error-code-EM02004\"> </a></td><td>The NHI Identifier provided <1> is dormant. This record cannot be updated</td></tr><tr><td style=\"white-space:nowrap\">EM02006<a name=\"hip-error-code-EM02006\"> </a></td><td>The patient identity information supplied may result in transformation of this NHI. Please resubmit or contact NHI administration</td></tr><tr><td style=\"white-space:nowrap\">EM02007<a name=\"hip-error-code-EM02007\"> </a></td><td>The request record version number does not match the current resource record version number</td></tr><tr><td style=\"white-space:nowrap\">EM02008<a name=\"hip-error-code-EM02008\"> </a></td><td>Patient identity information does not match Patient NHI supplied</td></tr><tr><td style=\"white-space:nowrap\">EM02009<a name=\"hip-error-code-EM02009\"> </a></td><td>Validate is only currently supported when sending an NHI Identifier (not an ID)</td></tr><tr><td style=\"white-space:nowrap\">EM02101<a name=\"hip-error-code-EM02101\"> </a></td><td>A Patient name must contain either a given or family name, a Name Type, a preferred name flag and an information source.</td></tr><tr><td style=\"white-space:nowrap\">EM02104<a name=\"hip-error-code-EM02104\"> </a></td><td>An active Patient Preferred Name must not be deleted</td></tr><tr><td style=\"white-space:nowrap\">EM02105<a name=\"hip-error-code-EM02105\"> </a></td><td>A Patient must not have more than 40 active names</td></tr><tr><td style=\"white-space:nowrap\">EM02106<a name=\"hip-error-code-EM02106\"> </a></td><td>A Patient must have an active Preferred Name</td></tr><tr><td style=\"white-space:nowrap\">EM02107<a name=\"hip-error-code-EM02107\"> </a></td><td>Must start with a letter of the alphabet or an apostrophe</td></tr><tr><td style=\"white-space:nowrap\">EM02110<a name=\"hip-error-code-EM02110\"> </a></td><td>Must contain at least one letter</td></tr><tr><td style=\"white-space:nowrap\">EM02201<a name=\"hip-error-code-EM02201\"> </a></td><td>A Patient must have a primary residential address</td></tr><tr><td style=\"white-space:nowrap\">EM02209<a name=\"hip-error-code-EM02209\"> </a></td><td>A validated mailing address must be an address at which mail can be delivered</td></tr><tr><td style=\"white-space:nowrap\">EM02301<a name=\"hip-error-code-EM02301\"> </a></td><td>A Patient must have at least one valid ethnicity code, only one instance of each selected ethnicity, and appropriate use of the residual ethnicity codes</td></tr><tr><td style=\"white-space:nowrap\">EM04003<a name=\"hip-error-code-EM04003\"> </a></td><td>address-line must match the address associated with Nz-address-id</td></tr><tr><td style=\"white-space:nowrap\">EM04005<a name=\"hip-error-code-EM04005\"> </a></td><td>A Patient Address must either be validated by the Te Whatu Ora address service, or have a qualifier to indicate why the address cannot be validated</td></tr><tr><td style=\"white-space:nowrap\">EM04006<a name=\"hip-error-code-EM04006\"> </a></td><td>Address line 1, address type, and not-validated-address-reason are required.</td></tr><tr><td style=\"white-space:nowrap\">EM04007<a name=\"hip-error-code-EM04007\"> </a></td><td>A validated address must contain Nz-address-id, Address line 1 and address type.</td></tr><tr><td style=\"white-space:nowrap\">EM07008<a name=\"hip-error-code-EM07008\"> </a></td><td>Requested attribute has been removed from the Patient record by NHI administration, contact NHI administration for more information</td></tr><tr><td style=\"white-space:nowrap\">EM07107<a name=\"hip-error-code-EM07107\"> </a></td><td>Set ID provided is invalid or inactive</td></tr><tr><td style=\"white-space:nowrap\">EM07201<a name=\"hip-error-code-EM07201\"> </a></td><td>Missing a required field</td></tr><tr><td style=\"white-space:nowrap\">EM07202<a name=\"hip-error-code-EM07202\"> </a></td><td>Field is required when another field is present</td></tr><tr><td style=\"white-space:nowrap\">EM07208<a name=\"hip-error-code-EM07208\"> </a></td><td>Invalid code for value set</td></tr><tr><td style=\"white-space:nowrap\">EM07212<a name=\"hip-error-code-EM07212\"> </a></td><td>Cannot be a future date</td></tr><tr><td style=\"white-space:nowrap\">EM07215<a name=\"hip-error-code-EM07215\"> </a></td><td>Date of Death must be greater than, or equal to Date of Birth</td></tr><tr><td style=\"white-space:nowrap\">EM07217<a name=\"hip-error-code-EM07217\"> </a></td><td>Contains invalid text</td></tr><tr><td style=\"white-space:nowrap\">EM07222<a name=\"hip-error-code-EM07222\"> </a></td><td>Already exists for this patient</td></tr><tr><td style=\"white-space:nowrap\">EM07223<a name=\"hip-error-code-EM07223\"> </a></td><td>The Patient Name is not active and cannot be updated</td></tr><tr><td style=\"white-space:nowrap\">EM07225<a name=\"hip-error-code-EM07225\"> </a></td><td>If name-use-extra is supplied name-use must be temp, and source NPRF</td></tr><tr><td style=\"white-space:nowrap\">EM07229<a name=\"hip-error-code-EM07229\"> </a></td><td>Can only be set by an authorised agency</td></tr><tr><td style=\"white-space:nowrap\">EM07237<a name=\"hip-error-code-EM07237\"> </a></td><td>Information source required when attribute is present</td></tr><tr><td style=\"white-space:nowrap\">EM07238<a name=\"hip-error-code-EM07238\"> </a></td><td>Attribute required if information source present</td></tr><tr><td style=\"white-space:nowrap\">EM07239<a name=\"hip-error-code-EM07239\"> </a></td><td>A source of HL7 or MIGR can only be submitted by A legacy update</td></tr><tr><td style=\"white-space:nowrap\">EM07240<a name=\"hip-error-code-EM07240\"> </a></td><td>Date of Death must be greater than, or equal to Date of Birth</td></tr><tr><td style=\"white-space:nowrap\">EM07241<a name=\"hip-error-code-EM07241\"> </a></td><td>Information set to registered cannot be updated, contact NHI administration for more information</td></tr><tr><td style=\"white-space:nowrap\">EM07242<a name=\"hip-error-code-EM07242\"> </a></td><td>Cannot update attribute source with a lower level of proof</td></tr><tr><td style=\"white-space:nowrap\">EM07301<a name=\"hip-error-code-EM07301\"> </a></td><td>Invalid code for operation</td></tr><tr><td style=\"white-space:nowrap\">EM07302<a name=\"hip-error-code-EM07302\"> </a></td><td>Must not be supplied on this operation</td></tr><tr><td style=\"white-space:nowrap\">EM07303<a name=\"hip-error-code-EM07303\"> </a></td><td>Date must be greater than date of birth</td></tr><tr><td style=\"white-space:nowrap\">EM07304<a name=\"hip-error-code-EM07304\"> </a></td><td>Delete not allowed</td></tr><tr><td style=\"white-space:nowrap\">EM07305<a name=\"hip-error-code-EM07305\"> </a></td><td>Request ID is invalid</td></tr><tr><td style=\"white-space:nowrap\">EM07306<a name=\"hip-error-code-EM07306\"> </a></td><td>Request NHI does not match the resource NHI</td></tr><tr><td style=\"white-space:nowrap\">EM07307<a name=\"hip-error-code-EM07307\"> </a></td><td>Contains duplicates</td></tr><tr><td style=\"white-space:nowrap\">EM11001<a name=\"hip-error-code-EM11001\"> </a></td><td>The request enrolment ID is invalid</td></tr><tr><td style=\"white-space:nowrap\">EM11002<a name=\"hip-error-code-EM11002\"> </a></td><td>The request enrolment ID provided is for an inactive enrolment</td></tr><tr><td style=\"white-space:nowrap\">EM11003<a name=\"hip-error-code-EM11003\"> </a></td><td>An enrolment of this type already exists for this patient with the requested organisation</td></tr><tr><td style=\"white-space:nowrap\">EM11005<a name=\"hip-error-code-EM11005\"> </a></td><td>A patient must not have more than one active enrolment for a health service</td></tr><tr><td style=\"white-space:nowrap\">EM11006<a name=\"hip-error-code-EM11006\"> </a></td><td>An enrolment has already been recorded for this patient today</td></tr><tr><td style=\"white-space:nowrap\">EM11007<a name=\"hip-error-code-EM11007\"> </a></td><td>This patient is older than three months, and cannot be pre-enrolled</td></tr><tr><td style=\"white-space:nowrap\">EM13001<a name=\"hip-error-code-EM13001\"> </a></td><td>Baby's NHI not found</td></tr><tr><td style=\"white-space:nowrap\">EM13002<a name=\"hip-error-code-EM13002\"> </a></td><td>The baby is already enrolled or pre-enrolled in NES</td></tr><tr><td style=\"white-space:nowrap\">EM13003<a name=\"hip-error-code-EM13003\"> </a></td><td>The baby has been marked as deceased in NHI</td></tr><tr><td style=\"white-space:nowrap\">EM13004<a name=\"hip-error-code-EM13004\"> </a></td><td>No nominated clinic has been provided</td></tr><tr><td style=\"white-space:nowrap\">EM13005<a name=\"hip-error-code-EM13005\"> </a></td><td>The nominated clinic provided cannot be found in HPI</td></tr><tr><td style=\"white-space:nowrap\">EM13006<a name=\"hip-error-code-EM13006\"> </a></td><td>The provided gender does not match the NHI record for the baby</td></tr><tr><td style=\"white-space:nowrap\">EM13007<a name=\"hip-error-code-EM13007\"> </a></td><td>The provided date of birth does not match the NHI record for the baby</td></tr><tr><td style=\"white-space:nowrap\">EM13008<a name=\"hip-error-code-EM13008\"> </a></td><td>The baby's gender is missing or invalid</td></tr><tr><td style=\"white-space:nowrap\">EM13009<a name=\"hip-error-code-EM13009\"> </a></td><td>The baby's date of birth is missing or invalid</td></tr><tr><td style=\"white-space:nowrap\">EM13010<a name=\"hip-error-code-EM13010\"> </a></td><td>No next of kin details provided</td></tr><tr><td style=\"white-space:nowrap\">EM13100<a name=\"hip-error-code-EM13100\"> </a></td><td>The nominated clinic EDI provided is invalid, HealthLink rejected the message</td></tr><tr><td style=\"white-space:nowrap\">EM12020<a name=\"hip-error-code-EM12020\"> </a></td><td>Entitlement cannot be found</td></tr><tr><td style=\"white-space:nowrap\">EM12021<a name=\"hip-error-code-EM12021\"> </a></td><td>Invalid entitlement-id</td></tr></table></div>"
},
"url" : "https://standards.digital.health.nz/ns/hip-error-code",
"version" : "1.0",
"name" : "Hip_error_code",
"title" : "HIP Error Code",
"status" : "active",
"experimental" : false,
"date" : "2017-09-01T00:00:00+13:00",
"publisher" : "Te Whatu Ora",
"contact" : [
{
"name" : "Te Whatu Ora",
"telecom" : [
{
"system" : "email",
"value" : "mailto:integration@health.govt.nz"
}
]
}
],
"description" : "HIP Error Codes",
"purpose" : "A coded value for HIP errors",
"caseSensitive" : false,
"valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/hip-error-code",
"versionNeeded" : false,
"content" : "complete",
"count" : 63,
"concept" : [
{
"code" : "EM02002",
"display" : "Cannot be found"
},
{
"code" : "EM02004",
"display" : "The NHI Identifier provided <1> is dormant. This record cannot be updated"
},
{
"code" : "EM02006",
"display" : "The patient identity information supplied may result in transformation of this NHI. Please resubmit or contact NHI administration"
},
{
"code" : "EM02007",
"display" : "The request record version number does not match the current resource record version number"
},
{
"code" : "EM02008",
"display" : "Patient identity information does not match Patient NHI supplied"
},
{
"code" : "EM02009",
"display" : "Validate is only currently supported when sending an NHI Identifier (not an ID)"
},
{
"code" : "EM02101",
"display" : "A Patient name must contain either a given or family name, a Name Type, a preferred name flag and an information source."
},
{
"code" : "EM02104",
"display" : "An active Patient Preferred Name must not be deleted"
},
{
"code" : "EM02105",
"display" : "A Patient must not have more than 40 active names"
},
{
"code" : "EM02106",
"display" : "A Patient must have an active Preferred Name"
},
{
"code" : "EM02107",
"display" : "Must start with a letter of the alphabet or an apostrophe"
},
{
"code" : "EM02110",
"display" : "Must contain at least one letter"
},
{
"code" : "EM02201",
"display" : "A Patient must have a primary residential address"
},
{
"code" : "EM02209",
"display" : "A validated mailing address must be an address at which mail can be delivered"
},
{
"code" : "EM02301",
"display" : "A Patient must have at least one valid ethnicity code, only one instance of each selected ethnicity, and appropriate use of the residual ethnicity codes"
},
{
"code" : "EM04003",
"display" : "address-line must match the address associated with Nz-address-id"
},
{
"code" : "EM04005",
"display" : "A Patient Address must either be validated by the Te Whatu Ora address service, or have a qualifier to indicate why the address cannot be validated"
},
{
"code" : "EM04006",
"display" : "Address line 1, address type, and not-validated-address-reason are required."
},
{
"code" : "EM04007",
"display" : "A validated address must contain Nz-address-id, Address line 1 and address type."
},
{
"code" : "EM07008",
"display" : "Requested attribute has been removed from the Patient record by NHI administration, contact NHI administration for more information"
},
{
"code" : "EM07107",
"display" : "Set ID provided is invalid or inactive"
},
{
"code" : "EM07201",
"display" : "Missing a required field"
},
{
"code" : "EM07202",
"display" : "Field is required when another field is present"
},
{
"code" : "EM07208",
"display" : "Invalid code for value set"
},
{
"code" : "EM07212",
"display" : "Cannot be a future date"
},
{
"code" : "EM07215",
"display" : "Date of Death must be greater than, or equal to Date of Birth"
},
{
"code" : "EM07217",
"display" : "Contains invalid text"
},
{
"code" : "EM07222",
"display" : "Already exists for this patient"
},
{
"code" : "EM07223",
"display" : "The Patient Name is not active and cannot be updated"
},
{
"code" : "EM07225",
"display" : "If name-use-extra is supplied name-use must be temp, and source NPRF"
},
{
"code" : "EM07229",
"display" : "Can only be set by an authorised agency"
},
{
"code" : "EM07237",
"display" : "Information source required when attribute is present"
},
{
"code" : "EM07238",
"display" : "Attribute required if information source present"
},
{
"code" : "EM07239",
"display" : "A source of HL7 or MIGR can only be submitted by A legacy update"
},
{
"code" : "EM07240",
"display" : "Date of Death must be greater than, or equal to Date of Birth"
},
{
"code" : "EM07241",
"display" : "Information set to registered cannot be updated, contact NHI administration for more information"
},
{
"code" : "EM07242",
"display" : "Cannot update attribute source with a lower level of proof"
},
{
"code" : "EM07301",
"display" : "Invalid code for operation"
},
{
"code" : "EM07302",
"display" : "Must not be supplied on this operation"
},
{
"code" : "EM07303",
"display" : "Date must be greater than date of birth"
},
{
"code" : "EM07304",
"display" : "Delete not allowed"
},
{
"code" : "EM07305",
"display" : "Request ID is invalid"
},
{
"code" : "EM07306",
"display" : "Request NHI does not match the resource NHI"
},
{
"code" : "EM07307",
"display" : "Contains duplicates"
},
{
"code" : "EM11001",
"display" : "The request enrolment ID is invalid"
},
{
"code" : "EM11002",
"display" : "The request enrolment ID provided is for an inactive enrolment"
},
{
"code" : "EM11003",
"display" : "An enrolment of this type already exists for this patient with the requested organisation"
},
{
"code" : "EM11005",
"display" : "A patient must not have more than one active enrolment for a health service"
},
{
"code" : "EM11006",
"display" : "An enrolment has already been recorded for this patient today"
},
{
"code" : "EM11007",
"display" : "This patient is older than three months, and cannot be pre-enrolled"
},
{
"code" : "EM13001",
"display" : "Baby's NHI not found"
},
{
"code" : "EM13002",
"display" : "The baby is already enrolled or pre-enrolled in NES"
},
{
"code" : "EM13003",
"display" : "The baby has been marked as deceased in NHI"
},
{
"code" : "EM13004",
"display" : "No nominated clinic has been provided"
},
{
"code" : "EM13005",
"display" : "The nominated clinic provided cannot be found in HPI"
},
{
"code" : "EM13006",
"display" : "The provided gender does not match the NHI record for the baby"
},
{
"code" : "EM13007",
"display" : "The provided date of birth does not match the NHI record for the baby"
},
{
"code" : "EM13008",
"display" : "The baby's gender is missing or invalid"
},
{
"code" : "EM13009",
"display" : "The baby's date of birth is missing or invalid"
},
{
"code" : "EM13010",
"display" : "No next of kin details provided"
},
{
"code" : "EM13100",
"display" : "The nominated clinic EDI provided is invalid, HealthLink rejected the message"
},
{
"code" : "EM12020",
"display" : "Entitlement cannot be found"
},
{
"code" : "EM12021",
"display" : "Invalid entitlement-id"
}
]
}