New Zealand HPI Implementation Guide - Local Development build (v1.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Updates a health provider's name, birthdate and death-date. - JSON Representation

Draft as of 2023-06-12

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "Practitioner-update-core",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Practitioner-update-core</b></p><a name=\"Practitioner-update-core\"> </a><a name=\"hcPractitioner-update-core\"> </a><a name=\"Practitioner-update-core-en-US\"> </a><p>URL: [base]/Practitioner/[id]/$practitioner-update-core</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>cpn</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The hpi-person-id (cpn)</p>\n</div></td></tr><tr><td>IN</td><td>version-id</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The current Practitioner record version number</p>\n</div></td></tr><tr><td>IN</td><td>ra-identifier</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The RA identifier</p>\n</div></td></tr><tr><td>IN</td><td>name</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>An update replaces the full set of name attributes (use, prefix, given, family)</p>\n</div></td></tr><tr><td>IN</td><td>death-date</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The Provider's date of death, can only be set by an admin user</p>\n</div></td></tr><tr><td>IN</td><td>birth-date</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The Provider's birthdate, can only be set by an admin user</p>\n</div></td></tr><tr><td>OUT</td><td>Practitioner</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/practitioner.html\">Practitioner</a></td><td/><td><div><p>The updated Practitioner resource</p>\n</div></td></tr><tr><td>OUT</td><td>failure</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>Error response</p>\n</div></td></tr></table><div><p>The cpn is validated, the versionId is validated. If all request parameters are valid If all request parameters are valid, then the parameter is replaced on the record</p>\n</div></div>"
  },
  "url" : "https://hpi-ig.hip.digital.health.nz/OperationDefinition/practitioner-update-core",
  "version" : "1.0.0",
  "name" : "Update Core ",
  "title" : "Updates a health provider's name, birthdate and death-date.",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2023-06-12T12:47:40+10:00",
  "publisher" : "Te Whatu Ora",
  "contact" : [
    {
      "name" : "Te Whatu Ora",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:integration@health.govt.nz"
        }
      ]
    }
  ],
  "description" : "Updates a health provider's name, birthdate, death-date",
  "affectsState" : true,
  "code" : "practitioner-update-core",
  "comment" : "The cpn is validated, the versionId is validated. If all request parameters are valid If all request parameters are valid, then the parameter is replaced on the record",
  "resource" : [
    "Practitioner"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "cpn",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The hpi-person-id (cpn)",
      "type" : "string"
    },
    {
      "name" : "version-id",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The current Practitioner record version number",
      "type" : "string"
    },
    {
      "name" : "ra-identifier",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The RA identifier",
      "type" : "string"
    },
    {
      "name" : "name",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "An update replaces the full set of name attributes (use, prefix, given, family)",
      "type" : "string"
    },
    {
      "name" : "death-date",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The Provider's date of death, can only be set by an admin user",
      "type" : "string"
    },
    {
      "name" : "birth-date",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The Provider's birthdate, can only be set by an admin user",
      "type" : "string"
    },
    {
      "name" : "Practitioner",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "The updated Practitioner resource",
      "type" : "Practitioner"
    },
    {
      "name" : "failure",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Error response",
      "type" : "OperationOutcome"
    }
  ]
}