1. FHIR DSTU 2 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. Patient

Create a patient

post

/Patient

Creates a patient.

Note:

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : PatientCreateBody
Type: object
Show Source
  • Allowed Values: [ true ]

    Whether this patient record is in active use.

  • address

    Addresses for the individual.

  • The date of birth for the individual.

    Example: 1989-09-17
  • careProvider

    Patient's nominated care provider.

  • communication
    Minimum Number of Items: 1
    Maximum Number of Items: 1

    Language which may be used to communicate with the patient about their health.

  • extension
    Minimum Number of Items: 1
    Maximum Number of Items: 1

    The Argonaut Birth Sex Extension is supported.

  • Allowed Values: [ "male", "female", "other", "unknown" ]

    The gender that the patient is considered to have for administration and record keeping purposes.

  • identifier
    Minimum Number of Items: 1

    The identifiers for the patient.

    At least one identifier must be provided. The provided identifier must be a reference to the Organization in which the patient is being enrolled.

    Subsequent identifiers may be provided, but have the following constraints:

    • Must not contain the assigner and use fields.
    • Must contain the type, system, and value fields.

    Example: 

    {
  "identifier": [
    {
      "assigner": {
        "reference": "Organization/685844"
      }
    },
    {
      "type": {
        "coding": [
          {
            "code": "MR",
            "system": "http://hl7.org/fhir/v2/0203"
          }
        ]
      },
      "system": "urn:oid:1.1.1.1.1.1",
      "value": "MR-1234",
      "period": {
        "start": "2016-01-02T00:00:00-05:00",
        "end": "2020-01-02T00:00:00-05:00"
      }
    }
  ]
}

  • maritalStatus

    The patient's most recent marital (civil) status.

  • name
    Minimum Number of Items: 1

    The names associated with the individual.

    At least one name must be provided.

    • It must have a use of official.
    • If a period is provided, it must not have an end date.
    • It must include both a given and a family name.

    All provided names:

    • Must not contain the text field.
    • Must contain either a given or family name.

    Example: 

    {
  "name": [
    {
      "use": "official",
      "family": [
        "Wolf"
      ],
      "given": [
        "Big",
        "Bad"
      ],
      "period": {
        "start": "2010-05-17T14:54:31.000Z"
      }
    },
    {
      "use": "usual",
      "given": [
        "Bigby"
      ],
      "period": {
        "start": "2012-05-22T15:45:50.000Z"
      }
    }
  ]
}

  • Allowed Values: [ "Patient" ]

    The type of the FHIR resource.

  • telecom

    A contact detail (such as a telephone number or an email address) by which the patient may be contacted.

Example:
{
    "resourceType":"Patient",
    "identifier":[
        {
            "assigner":{
                "reference":"Organization/685844"
            }
        }
    ],
    "active":true,
    "name":[
        {
            "use":"official",
            "family":[
                "Wolf"
            ],
            "given":[
                "Person",
                "Name"
            ],
            "period":{
                "start":"2010-05-17T14:54:31.000Z"
            }
        },
        {
            "use":"usual",
            "given":[
                "Bigby"
            ],
            "period":{
                "start":"2012-05-22T15:45:50.000Z"
            }
        }
    ],
    "telecom":[
        {
            "system":"phone",
            "value":"8168229121",
            "use":"home",
            "period":{
                "start":"2012-05-17T15:33:18.000Z"
            }
        }
    ],
    "gender":"male",
    "birthDate":"1990-09-15",
    "address":[
        {
            "use":"home",
            "line":[
                "121212 Metcalf Drive",
                "Apartment 403"
            ],
            "city":"Kansas City",
            "district":"Jackson",
            "state":"KS",
            "postalCode":"64199",
            "country":"United States of America",
            "period":{
                "start":"2012-05-17T15:33:18.000Z"
            }
        }
    ],
    "maritalStatus":{
        "coding":[
            {
                "system":"http://hl7.org/fhir/v3/NullFlavor",
                "code":"UNK",
                "display":"Unknown"
            }
        ],
        "text":"Unknown"
    },
    "communication":[
        {
            "language":{
                "coding":[
                    {
                        "system":"urn:ietf:bcp:47",
                        "code":"en",
                        "display":"English"
                    }
                ],
                "text":"English"
            },
            "preferred":true
        }
    ],
    "careProvider":[
        {
            "reference":"Practitioner/4122622"
        }
    ]
}
Nested Schema : address
Type: array

Addresses for the individual.

Show Source
Nested Schema : careProvider
Type: array

Patient's nominated care provider.

Show Source
Nested Schema : communication
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1

Language which may be used to communicate with the patient about their health.

Show Source
Nested Schema : extension
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1

The Argonaut Birth Sex Extension is supported.

Show Source
Nested Schema : identifier
Type: array
Minimum Number of Items: 1

The identifiers for the patient.

At least one identifier must be provided. The provided identifier must be a reference to the Organization in which the patient is being enrolled.

Subsequent identifiers may be provided, but have the following constraints:

  • Must not contain the assigner and use fields.
  • Must contain the type, system, and value fields.

Example: 

{
  "identifier": [
    {
      "assigner": {
        "reference": "Organization/685844"
      }
    },
    {
      "type": {
        "coding": [
          {
            "code": "MR",
            "system": "http://hl7.org/fhir/v2/0203"
          }
        ]
      },
      "system": "urn:oid:1.1.1.1.1.1",
      "value": "MR-1234",
      "period": {
        "start": "2016-01-02T00:00:00-05:00",
        "end": "2020-01-02T00:00:00-05:00"
      }
    }
  ]
}

Show Source
Nested Schema : maritalStatus
Type: object

The patient's most recent marital (civil) status.

Show Source
Nested Schema : name
Type: array
Minimum Number of Items: 1

The names associated with the individual.

At least one name must be provided.

  • It must have a use of official.
  • If a period is provided, it must not have an end date.
  • It must include both a given and a family name.

All provided names:

  • Must not contain the text field.
  • Must contain either a given or family name.

Example: 

{
  "name": [
    {
      "use": "official",
      "family": [
        "Wolf"
      ],
      "given": [
        "Big",
        "Bad"
      ],
      "period": {
        "start": "2010-05-17T14:54:31.000Z"
      }
    },
    {
      "use": "usual",
      "given": [
        "Bigby"
      ],
      "period": {
        "start": "2012-05-22T15:45:50.000Z"
      }
    }
  ]
}

Show Source
Nested Schema : telecom
Type: array

A contact detail (such as a telephone number or an email address) by which the patient may be contacted.

Show Source
Nested Schema : items
Type: object

Must not contain the text field.

Show Source
Nested Schema : line
Type: array
Show Source
Example:
[
    "1212 Faircastle Drive",
    "Apartment 406"
]
Nested Schema : period
Type: object
Show Source
Nested Schema : items
Type: object

Must be a reference to a Practitioner.

Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : language
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "http://hl7.org/fhir/v3/AdministrativeGender", "http://hl7.org/fhir/v3/NullFlavor" ]
  • Allowed Values: [ "F", "M", "UNK" ]
Nested Schema : items
Type: object
Show Source
Nested Schema : period
Type: object
Show Source

  • Must include a time component with a timezone.

    Example: 2029-12-01T23:59:59.000Z

  • Must include a time component with a timezone.

    Example: 2019-12-01T00:00:00.000Z
Nested Schema : type
Type: object
Show Source
Nested Schema : coding
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object

See the Marital Status Codes for valid system-code pairs.

Show Source
  • Allowed Values: [ "U", "A", "D", "I", "L", "M", "P", "S", "T", "W", "UNK" ]
  • Allowed Values: [ "http://hl7.org/fhir/marital-status", "http://hl7.org/fhir/v3/MaritalStatus", "http://hl7.org/fhir/v3/NullFlavor" ]
Nested Schema : items
Type: object

Must not include the text field.

Show Source
  • family
    Minimum Number of Items: 1
    Maximum Number of Items: 1

    If more than one family name is required, they must be provided as a single string separated by blank spaces.

  • given
    Minimum Number of Items: 1
    Maximum Number of Items: 2

    If more than two given names are required, the additional names must be provided in the second value as a single string separated by blank spaces.

  • period

    Must not include an end date.

  • prefix
    Minimum Number of Items: 1
    Maximum Number of Items: 1
  • suffix
    Minimum Number of Items: 1
    Maximum Number of Items: 1
  • Allowed Values: [ "usual", "official", "temp", "nickname", "anonymous", "old", "maiden" ]
Nested Schema : family
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1

If more than one family name is required, they must be provided as a single string separated by blank spaces.

Show Source
Nested Schema : given
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2

If more than two given names are required, the additional names must be provided in the second value as a single string separated by blank spaces.

Show Source
Nested Schema : period
Type: object

Must not include an end date.

Show Source

  • Must include a time component with a timezone.

    Example: 2020-12-01T00:00:00.000Z
Nested Schema : prefix
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
Nested Schema : suffix
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : period
Type: object
Show Source

  • Must include a time component with a timezone.

    Example: 2028-05-17T15:33:18.000Z

  • Must include a time component with a timezone.

    Example: 2012-05-17T15:33:18.000Z
Back to Top

Response

Supported Media Types

Default Response

This operation supports the following authorization types:
  • Provider
  • System
Example Request: 
POST https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient
Example Response: 
Date: Tue, 27 Feb 2018 16:47:59 GMT
Cache-Control: no-cache
Vary: Origin,User-Agent,Accept-Encoding
Strict-Transport-Security: max-age=631152000
X-Xss-Protection: 1; mode=block
Pragma: no-cache
X-Request-Id: 111111111111111111111111111111111111
opc-request-id: /5E94C5FFC27CDD51DB70C0F464E44A96/AECA8B137DC613A323E70B1ED7C53808
Etag: W/"0"
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
Expires: Mon, 01 Jan 1990 00:00:00 GMT
Last-Modified: Tue, 27 Feb 2018 16:48:00 GMT
Location: https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/4842008
Content-Length: 0
Content-Type: application/json
The ETag response header indicates the current If-Match version to use on a subsequent update.
Back to Top