New Zealand NHI IG
1.6.5 - Release

New Zealand NHI IG - Local Development build (v1.6.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : Patient-create - JSON Representation

Draft as of 2022-05-28

Raw json | Download

    {
      "resourceType" : "OperationDefinition",
      "id" : "Patient-create",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Patient-create</b></p><a name=\"Patient-create\"> </a><a name=\"hcPatient-create\"> </a><p>URL: [base]/Patient/$create</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>patient</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a> (<a href=\"StructureDefinition-CreateNhiPatient.html\" title=\"http://hl7.org.nz/fhir/StructureDefinition/CreateNhiPatient\">Create NHI Patient</a>)</td><td/><td/></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>The updated patient 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 patient information is validated. If all request parameters are valid the new patient is created in the NHI</p>\n</div></div>"
      },
      "url" : "https://nhi-ig.hip.digital.health.nz/OperationDefinition/create-patient",
      "version" : "1.6.5",
      "name" : "Create Patient",
      "status" : "draft",
      "kind" : "operation",
      "date" : "2022-05-28T12:47:40+10:00",
      "publisher" : "Te Whatu Ora",
      "contact" : [
        {
          "name" : "Te Whatu Ora",
          "telecom" : [
            {
              "system" : "email",
              "value" : "mailto:integration@health.govt.nz"
            }
          ]
        }
      ],
      "description" : "create a patient in the NHI",
      "affectsState" : true,
      "code" : "create",
      "comment" : "The patient information is validated. If all request parameters are valid the new patient is created in the NHI",
      "resource" : [
        "Patient"
      ],
      "system" : false,
      "type" : true,
      "instance" : false,
      "parameter" : [
        {
          "name" : "patient",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "type" : "Patient",
          "targetProfile" : [
            🔗 "http://hl7.org.nz/fhir/StructureDefinition/CreateNhiPatient"
          ]
        },
        {
          "name" : "return",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "The updated patient resource",
          "type" : "Patient"
        },
        {
          "name" : "failure",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "Error response",
          "type" : "OperationOutcome"
        }
      ]
    }