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 |
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource ------------------------------------------------------------------- a fhir:CodeSystem ; fhir:nodeRole fhir:treeRoot ; fhir:id [ fhir:v "hip-error-code"] ; # fhir:meta [ ( fhir:profile [ fhir:v "http://hl7.org/fhir/StructureDefinition/shareablecodesystem"^^xsd:anyURI ; fhir:link <http://hl7.org/fhir/StructureDefinition/shareablecodesystem> ] ) ] ; # fhir:text [ fhir:status [ fhir:v "generated" ] ; fhir: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>" ] ; # fhir:url [ fhir:v "https://standards.digital.health.nz/ns/hip-error-code"^^xsd:anyURI] ; # fhir:version [ fhir:v "1.0"] ; # fhir:name [ fhir:v "Hip_error_code"] ; # fhir:title [ fhir:v "HIP Error Code"] ; # fhir:status [ fhir:v "active"] ; # fhir:experimental [ fhir:v "false"^^xsd:boolean] ; # fhir:date [ fhir:v "2017-09-01T00:00:00+13:00"^^xsd:dateTime] ; # fhir:publisher [ fhir:v "Te Whatu Ora"] ; # fhir:contact ( [ fhir:name [ fhir:v "Te Whatu Ora" ] ; ( fhir:telecom [ fhir:system [ fhir:v "email" ] ; fhir:value [ fhir:v "mailto:integration@health.govt.nz" ] ] ) ] ) ; # fhir:description [ fhir:v "HIP Error Codes"] ; # fhir:purpose [ fhir:v "A coded value for HIP errors"] ; # fhir:caseSensitive [ fhir:v "false"^^xsd:boolean] ; # fhir:valueSet [ fhir:v "https://nzhts.digital.health.nz/fhir/ValueSet/hip-error-code"^^xsd:anyURI ; fhir:link <https://nzhts.digital.health.nz/fhir/ValueSet/hip-error-code> ] ; # fhir:versionNeeded [ fhir:v "false"^^xsd:boolean] ; # fhir:content [ fhir:v "complete"] ; # fhir:count [ fhir:v "63"^^xsd:nonNegativeInteger] ; # fhir:concept ( [ fhir:code [ fhir:v "EM02002" ] ; fhir:display [ fhir:v "Cannot be found" ] ] [ fhir:code [ fhir:v "EM02004" ] ; fhir:display [ fhir:v "The NHI Identifier provided <1> is dormant. This record cannot be updated" ] ] [ fhir:code [ fhir:v "EM02006" ] ; fhir:display [ fhir:v "The patient identity information supplied may result in transformation of this NHI. Please resubmit or contact NHI administration" ] ] [ fhir:code [ fhir:v "EM02007" ] ; fhir:display [ fhir:v "The request record version number does not match the current resource record version number" ] ] [ fhir:code [ fhir:v "EM02008" ] ; fhir:display [ fhir:v "Patient identity information does not match Patient NHI supplied" ] ] [ fhir:code [ fhir:v "EM02009" ] ; fhir:display [ fhir:v "Validate is only currently supported when sending an NHI Identifier (not an ID)" ] ] [ fhir:code [ fhir:v "EM02101" ] ; fhir:display [ fhir:v "A Patient name must contain either a given or family name, a Name Type, a preferred name flag and an information source." ] ] [ fhir:code [ fhir:v "EM02104" ] ; fhir:display [ fhir:v "An active Patient Preferred Name must not be deleted" ] ] [ fhir:code [ fhir:v "EM02105" ] ; fhir:display [ fhir:v "A Patient must not have more than 40 active names" ] ] [ fhir:code [ fhir:v "EM02106" ] ; fhir:display [ fhir:v "A Patient must have an active Preferred Name" ] ] [ fhir:code [ fhir:v "EM02107" ] ; fhir:display [ fhir:v "Must start with a letter of the alphabet or an apostrophe" ] ] [ fhir:code [ fhir:v "EM02110" ] ; fhir:display [ fhir:v "Must contain at least one letter" ] ] [ fhir:code [ fhir:v "EM02201" ] ; fhir:display [ fhir:v "A Patient must have a primary residential address" ] ] [ fhir:code [ fhir:v "EM02209" ] ; fhir:display [ fhir:v "A validated mailing address must be an address at which mail can be delivered" ] ] [ fhir:code [ fhir:v "EM02301" ] ; fhir:display [ fhir:v "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" ] ] [ fhir:code [ fhir:v "EM04003" ] ; fhir:display [ fhir:v "address-line must match the address associated with Nz-address-id" ] ] [ fhir:code [ fhir:v "EM04005" ] ; fhir:display [ fhir:v "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" ] ] [ fhir:code [ fhir:v "EM04006" ] ; fhir:display [ fhir:v "Address line 1, address type, and not-validated-address-reason are required." ] ] [ fhir:code [ fhir:v "EM04007" ] ; fhir:display [ fhir:v "A validated address must contain Nz-address-id, Address line 1 and address type." ] ] [ fhir:code [ fhir:v "EM07008" ] ; fhir:display [ fhir:v "Requested attribute has been removed from the Patient record by NHI administration, contact NHI administration for more information" ] ] [ fhir:code [ fhir:v "EM07107" ] ; fhir:display [ fhir:v "Set ID provided is invalid or inactive" ] ] [ fhir:code [ fhir:v "EM07201" ] ; fhir:display [ fhir:v "Missing a required field" ] ] [ fhir:code [ fhir:v "EM07202" ] ; fhir:display [ fhir:v "Field is required when another field is present" ] ] [ fhir:code [ fhir:v "EM07208" ] ; fhir:display [ fhir:v "Invalid code for value set" ] ] [ fhir:code [ fhir:v "EM07212" ] ; fhir:display [ fhir:v "Cannot be a future date" ] ] [ fhir:code [ fhir:v "EM07215" ] ; fhir:display [ fhir:v "Date of Death must be greater than, or equal to Date of Birth" ] ] [ fhir:code [ fhir:v "EM07217" ] ; fhir:display [ fhir:v "Contains invalid text" ] ] [ fhir:code [ fhir:v "EM07222" ] ; fhir:display [ fhir:v "Already exists for this patient" ] ] [ fhir:code [ fhir:v "EM07223" ] ; fhir:display [ fhir:v "The Patient Name is not active and cannot be updated" ] ] [ fhir:code [ fhir:v "EM07225" ] ; fhir:display [ fhir:v "If name-use-extra is supplied name-use must be temp, and source NPRF" ] ] [ fhir:code [ fhir:v "EM07229" ] ; fhir:display [ fhir:v "Can only be set by an authorised agency" ] ] [ fhir:code [ fhir:v "EM07237" ] ; fhir:display [ fhir:v "Information source required when attribute is present" ] ] [ fhir:code [ fhir:v "EM07238" ] ; fhir:display [ fhir:v "Attribute required if information source present" ] ] [ fhir:code [ fhir:v "EM07239" ] ; fhir:display [ fhir:v "A source of HL7 or MIGR can only be submitted by A legacy update" ] ] [ fhir:code [ fhir:v "EM07240" ] ; fhir:display [ fhir:v "Date of Death must be greater than, or equal to Date of Birth" ] ] [ fhir:code [ fhir:v "EM07241" ] ; fhir:display [ fhir:v "Information set to registered cannot be updated, contact NHI administration for more information" ] ] [ fhir:code [ fhir:v "EM07242" ] ; fhir:display [ fhir:v "Cannot update attribute source with a lower level of proof" ] ] [ fhir:code [ fhir:v "EM07301" ] ; fhir:display [ fhir:v "Invalid code for operation" ] ] [ fhir:code [ fhir:v "EM07302" ] ; fhir:display [ fhir:v "Must not be supplied on this operation" ] ] [ fhir:code [ fhir:v "EM07303" ] ; fhir:display [ fhir:v "Date must be greater than date of birth" ] ] [ fhir:code [ fhir:v "EM07304" ] ; fhir:display [ fhir:v "Delete not allowed" ] ] [ fhir:code [ fhir:v "EM07305" ] ; fhir:display [ fhir:v "Request ID is invalid" ] ] [ fhir:code [ fhir:v "EM07306" ] ; fhir:display [ fhir:v "Request NHI does not match the resource NHI" ] ] [ fhir:code [ fhir:v "EM07307" ] ; fhir:display [ fhir:v "Contains duplicates" ] ] [ fhir:code [ fhir:v "EM11001" ] ; fhir:display [ fhir:v "The request enrolment ID is invalid" ] ] [ fhir:code [ fhir:v "EM11002" ] ; fhir:display [ fhir:v "The request enrolment ID provided is for an inactive enrolment" ] ] [ fhir:code [ fhir:v "EM11003" ] ; fhir:display [ fhir:v "An enrolment of this type already exists for this patient with the requested organisation" ] ] [ fhir:code [ fhir:v "EM11005" ] ; fhir:display [ fhir:v "A patient must not have more than one active enrolment for a health service" ] ] [ fhir:code [ fhir:v "EM11006" ] ; fhir:display [ fhir:v "An enrolment has already been recorded for this patient today" ] ] [ fhir:code [ fhir:v "EM11007" ] ; fhir:display [ fhir:v "This patient is older than three months, and cannot be pre-enrolled" ] ] [ fhir:code [ fhir:v "EM13001" ] ; fhir:display [ fhir:v "Baby's NHI not found" ] ] [ fhir:code [ fhir:v "EM13002" ] ; fhir:display [ fhir:v "The baby is already enrolled or pre-enrolled in NES" ] ] [ fhir:code [ fhir:v "EM13003" ] ; fhir:display [ fhir:v "The baby has been marked as deceased in NHI" ] ] [ fhir:code [ fhir:v "EM13004" ] ; fhir:display [ fhir:v "No nominated clinic has been provided" ] ] [ fhir:code [ fhir:v "EM13005" ] ; fhir:display [ fhir:v "The nominated clinic provided cannot be found in HPI" ] ] [ fhir:code [ fhir:v "EM13006" ] ; fhir:display [ fhir:v "The provided gender does not match the NHI record for the baby" ] ] [ fhir:code [ fhir:v "EM13007" ] ; fhir:display [ fhir:v "The provided date of birth does not match the NHI record for the baby" ] ] [ fhir:code [ fhir:v "EM13008" ] ; fhir:display [ fhir:v "The baby's gender is missing or invalid" ] ] [ fhir:code [ fhir:v "EM13009" ] ; fhir:display [ fhir:v "The baby's date of birth is missing or invalid" ] ] [ fhir:code [ fhir:v "EM13010" ] ; fhir:display [ fhir:v "No next of kin details provided" ] ] [ fhir:code [ fhir:v "EM13100" ] ; fhir:display [ fhir:v "The nominated clinic EDI provided is invalid, HealthLink rejected the message" ] ] [ fhir:code [ fhir:v "EM12020" ] ; fhir:display [ fhir:v "Entitlement cannot be found" ] ] [ fhir:code [ fhir:v "EM12021" ] ; fhir:display [ fhir:v "Invalid entitlement-id" ] ] ) . #
IG © 2022+ Te Whatu Ora. Package tewhatuora.hip-core#1.9.2 based on FHIR 4.0.1. Generated 2024-10-25
Links: Table of Contents |
QA Report