New Zealand NHI IG
1.5.4 - Release
New Zealand NHI IG - Local Development build (v1.5.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
The update address operations allow an authorised user to update a persons address on a persons identity record
Update address has three sub-operations available:
Set-address - Processing steps:
Parameter name | Parameter type | Mandatory / Optional | Description |
---|---|---|---|
nhi | valueString | Mandatory | The patients nhi number |
version-id | valueString | Mandatory | The current patient version number |
address-type | valueString | Mandatory | postal or physical |
nz-address-id | valueString | Mandatory | eSAM validated address id |
address-line | valueString | Mandatory | first line of the address as returned by eSAM |
address-building-name | valueString | Optional | The building name, this is additional information and is not returned as part of the eSAM address |
{
"resourceType": "Parameters",
"id": "example",
"parameter": [
{
"name" : "nhi",
"valueString" : "ZGD9203"
},
{
"name" : "version-id",
"valueString" : "3321540"
},
{
"name" : "address-type",
"valueString" : "physical"
},
{
"name" : "nz-address-id",
"valueString" : "2843216"
},
{
"name" : "address-line",
"valueString" : "20 Aitken Street"
},
{
"name" : "address-building-name",
"valueString" : "Freyberg House"
}
]
}
For Request rules and errors click here
Set-unvalidated-address - Processing steps:
Parameter name | Parameter type | Mandatory / Optional | Description |
---|---|---|---|
nhi | valueString | Mandatory | The patients nhi number |
version-id | valueString | Mandatory | The current patient version number |
not-validated-address-reason | valueString | Mandatory | |
address-type | valueString | Mandatory | postal or physical |
address-building-name | valueString | Optional | |
address-line-1 | valueString | Mandatory | first line of the address |
address-line-2 | valueString | Optional | second line of the address |
address-suburb | valueString | Optional | |
address-city | valueString | Optional | |
address-postal-code | valueString | Optional | |
address-country-code | valueString | Optional | |
address-domicile-code | valueString | Optional* | See future functionality below |
{
"resourceType": "Parameters",
"id": "example",
"parameter": [
{
"name" : "nhi",
"valueString" : "ZAD2481"
},
{
"name" : "version-id",
"valueString" : "19232"
},
{
"name" : "not-validated-address-reason",
"valueString" : "OSEA"
},
{
"name" : "address-type",
"valueString" : "physical"
},
{
"name" : "address-building-name",
"valueString" : "Building 11"
},
{
"name" : "address-line-1",
"valueString" : "67 nowhere street"
},
{
"name" : "address-line-2",
"valueString" : "nowhere"
},
{
"name" : "address-suburb",
"valueString" : "darksideodthetracks"
},
{
"name" : "address-city",
"valueString" : "darkside"
},
{
"name" : "address-postal-code",
"valueString" : "60606"
},
{
"name" : "address-country-code",
"valueString" : "NZ"
}
]
}
For Request rules and errors click here
Remove-postal-address - Processing steps:
Parameter name | Parameter type | Mandatory / Optional | Description |
---|---|---|---|
nhi | valueString | Mandatory | The patients nhi number |
version-id | valueString | Mandatory | The current patient version number |
{
"resourceType": "Parameters",
"id": "example",
"parameter": [
{
"name" : "nhi",
"valueString" : "ZAD2481"
},
{
"name" : "version-id",
"valueString" : "19232"
}
]
}
For Request rules and errors click here