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

Create a patient

post

/Patient

Creates a new patient.

Authorization Types

This resource supports the following authorization types:

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : PatientCreateBody
Type: object
Show Source
  • address

    Addresses for the individual.

    At least one of the following should be provided:

    • line
    • city
    • district
    • state
    • postalCode
    • country

    Each address must not contain the text field.

  • The date of birth for the individual.

    Example: 1990-09-15
  • communication
    Maximum Number of Items: 1

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

  • extension

    The Patient resource supports multiple extensions. See the StructureDefinition of each extension for further formatting details.

    US Core Birth Sex

    The sex of the patient at birth.

    Example: 

    {
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
  "valueCode": "F"
}

    US Core Ethnicity

    The ethnicity of the patient.

    Example: 

    
{
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
  "extension": [
    {
      "url": "ombCategory",
      "valueCoding": {
        "system": "urn:oid:2.16.840.1.113883.6.238",
        "code": "2186-5",
        "display": "Non Hispanic or Latino"
      }
    }
  ]
}

    US Core Race

    The race of the patient.

    Example: 

    {
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
  "extension": [
    {
      "url": "ombCategory",
      "valueCoding": {
        "system": "urn:oid:2.16.840.1.113883.6.238",
        "code": "2028-9",
        "display": "Asian"
      }
    },
    {
      "url": "detailed",
      "valueCoding": {
        "system": "urn:oid:2.16.840.1.113883.6.238",
        "code": "2039-6",
        "display": "Japanese"
      }
    }
  ]
}

    US Core Gender Identity

    The US Core Gender Identity extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is.

    Example: 

    {
  "valueCodeableConcept": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "446141000124107"
      }
    ]
  },
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
}

    US Core Sex

    The US Core Sex extension is used to reflect the documentation of a person's sex.

    Example: 

    {
  "valueCode": "248153007",
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex"
}

    US Core Tribal Affiliation

    The US Core Tribal Affiliation extension represents a tribe or band with which a person associates and, optionally, whether they are enrolled.

    Example: 

    {
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation",
  "extension": [
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
            "code": "472",
            "display": "Native Village of Napaskiak"
          }
        ],
        "text": "Native Village of Napaskiak"
      },
      "url": "tribalAffiliation"
    },
    {
      "valueBoolean": true,
      "url": "isEnrolled"
    }
  ]
}

    Communication Preference

    The communication preference for the patient.

    Example: 

    {
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference",
      "extension": [
        {
          "extension": [
            {
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4640016",
                    "code": "485602703",
                    "display": "Appointment Reminder",
                    "userSelected": false
                  }
                ],
                "text": "Appointment Reminder"
              },
              "url": "communication-type"
            },
            {
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/23042",
                    "code": "4054467",
                    "display": "Phone",
                    "userSelected": false
                  }
                ]
                },
              "url": "contact-method"
            },
            {
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/43",
                    "code": "163",
                    "display": "Business",
                    "userSelected": false
                  }
                ],
                "text": "Home"
              },
              "url": "contact-type"
            }
          ],
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference",
      "verified": "2019-12-26T15:41:52.000Z"
    }
  ]
}

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

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

  • generalPractitioner

    Patient's nominated care provider.

  • 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/619848"
      }
    },
    {
      "type": {
        "coding": [
          {
            "code": "MR",
            "system": "http://hl7.org/fhir/v2/0203"
          }
        ]
      },
      "system": "urn:oid:1.1.1.1.1.1",
      "value": "<unique identifier>",
      "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 name associated with the practitioner.

    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.

  • 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 individual may be contacted.

    If an extension is provided:

    • The extension.valueString field has a character limit of 100.
    • The system field must be phone.
    • The extension.url field must be http://hl7.org/fhir/StructureDefinition/contactpoint-extension.

Example:
{
  "resourceType": "Patient",
  "extension": [
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
      "valueCode": "M"
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2028-9",
            "display": "Asian"
          }
        },
        {
          "url": "detailed",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2039-6",
            "display": "Japanese"
          }
        }
      ]
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2186-5",
            "display": "Non Hispanic or Latino"
          }
        }
      ]
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "446141000124107"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
      "valueCode": "248153007"
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation",
      "extension": [
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
                "code": "472",
                "display": "Native Village of Napaskiak",
                "userSelected": true
              }
            ],
            "text": "Native Village of Napaskiak"
          },
          "url": "tribalAffiliation"
        },
        {
          "valueBoolean": true,
          "url": "isEnrolled"
        }
      ]
    },
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference",
      "extension": [
        {
          "extension": [
            {
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4640016",
                    "code": "485602703",
                    "display": "Appointment Reminder",
                    "userSelected": false
                  }
                ],
                "text": "Appointment Reminder"
              },
              "url": "communication-type"
            },
            {
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/23042",
                    "code": "4054467",
                    "display": "Phone",
                    "userSelected": false
                  }
                ]
              },
              "url": "contact-method"
            },
            {
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/43",
                    "code": "163",
                    "display": "Business",
                    "userSelected": false
                  }
                ],
                "text": "Home"
              },
              "url": "contact-type"
            }
          ],
          "verified": "2019-12-26T15:41:52.000Z"
        }
      ]
    }
  ],
  "identifier": [
    {
      "assigner": {
        "reference": "Organization/675844"
      }
    }
  ],
  "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",
      "id": "CI-PH-29811920-0",
      "extension": [
        {
          "valueString": "12345",
          "url": "http://hl7.org/fhir/StructureDefinition/contactpoint-extension"
        }
      ],
      "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://terminology.hl7.org/CodeSystem/v3-NullFlavor",
        "code": "UNK",
        "display": "Unknown"
      }
    ],
    "text": "Unknown"
  },
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "urn:ietf:bcp:47",
            "code": "en",
            "display": "English"
          }
        ],
        "text": "English"
      },
      "preferred": true
    }
  ],
  "generalPractitioner": [
    {
      "reference": "Practitioner/4122622"
    }
  ]
}
Nested Schema : address
Type: array

Addresses for the individual.

At least one of the following should be provided:

  • line
  • city
  • district
  • state
  • postalCode
  • country

Each address must not contain the text field.

Show Source
Nested Schema : communication
Type: array
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

The Patient resource supports multiple extensions. See the StructureDefinition of each extension for further formatting details.

US Core Birth Sex

The sex of the patient at birth.

Example: 

{
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
  "valueCode": "F"
}

US Core Ethnicity

The ethnicity of the patient.

Example: 


{
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
  "extension": [
    {
      "url": "ombCategory",
      "valueCoding": {
        "system": "urn:oid:2.16.840.1.113883.6.238",
        "code": "2186-5",
        "display": "Non Hispanic or Latino"
      }
    }
  ]
}

US Core Race

The race of the patient.

Example: 

{
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
  "extension": [
    {
      "url": "ombCategory",
      "valueCoding": {
        "system": "urn:oid:2.16.840.1.113883.6.238",
        "code": "2028-9",
        "display": "Asian"
      }
    },
    {
      "url": "detailed",
      "valueCoding": {
        "system": "urn:oid:2.16.840.1.113883.6.238",
        "code": "2039-6",
        "display": "Japanese"
      }
    }
  ]
}

US Core Gender Identity

The US Core Gender Identity extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is.

Example: 

{
  "valueCodeableConcept": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "446141000124107"
      }
    ]
  },
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
}

US Core Sex

The US Core Sex extension is used to reflect the documentation of a person's sex.

Example: 

{
  "valueCode": "248153007",
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex"
}

US Core Tribal Affiliation

The US Core Tribal Affiliation extension represents a tribe or band with which a person associates and, optionally, whether they are enrolled.

Example: 

{
  "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation",
  "extension": [
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
            "code": "472",
            "display": "Native Village of Napaskiak"
          }
        ],
        "text": "Native Village of Napaskiak"
      },
      "url": "tribalAffiliation"
    },
    {
      "valueBoolean": true,
      "url": "isEnrolled"
    }
  ]
}

Communication Preference

The communication preference for the patient.

Example: 

{
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference",
      "extension": [
        {
          "extension": [
            {
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4640016",
                    "code": "485602703",
                    "display": "Appointment Reminder",
                    "userSelected": false
                  }
                ],
                "text": "Appointment Reminder"
              },
              "url": "communication-type"
            },
            {
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/23042",
                    "code": "4054467",
                    "display": "Phone",
                    "userSelected": false
                  }
                ]
                },
              "url": "contact-method"
            },
            {
              "valueCodeableConcept": {
                "coding": [
                  {
                    "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/43",
                    "code": "163",
                    "display": "Business",
                    "userSelected": false
                  }
                ],
                "text": "Home"
              },
              "url": "contact-type"
            }
          ],
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/communication-preference",
      "verified": "2019-12-26T15:41:52.000Z"
    }
  ]
}

Show Source
Nested Schema : generalPractitioner
Type: array

Patient's nominated care provider.

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/619848"
      }
    },
    {
      "type": {
        "coding": [
          {
            "code": "MR",
            "system": "http://hl7.org/fhir/v2/0203"
          }
        ]
      },
      "system": "urn:oid:1.1.1.1.1.1",
      "value": "<unique identifier>",
      "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 name associated with the practitioner.

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.

Show Source
Nested Schema : telecom
Type: array

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

If an extension is provided:

  • The extension.valueString field has a character limit of 100.
  • The system field must be phone.
  • The extension.url field must be http://hl7.org/fhir/StructureDefinition/contactpoint-extension.

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

  • Must include a time component with a timezone.

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

  • Must include a time component with a timezone.

    Example: 2012-05-17T15:33:18.000Z
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
Nested Schema : items
Type: object

Must only include references to Practitioners.

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: 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
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : given
Type: array
Minimum Number of Items: 1
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
Maximum Number of Items: 1
Show Source
Nested Schema : suffix
Type: array
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

200 Response

OK

Headers
  • The identifier for a specific version of a resource. This identifier is formatted as W/"" and used to specify the If-Match header value on subsequent updates.
  • The URL location of the created entity.

    Example: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/5786010

  • Oracle troubleshooting identifier.

  • Oracle troubleshooting identifier.

Default Response

This operation supports the following authorization types: Example Request: 
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient
Example Response: 
Cache-Control: no-cache
Content-Length: 0
Content-Type: text/html
Date: Wed, 27 Mar 2019 17:23:14 GMT
Etag: W/"0"
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/5786010
Last-Modified: Wed, 27 Mar 2019 17:23:14 GMT
Vary: Origin
X-Request-Id: 11111111111111111111111111111111
opc-request-id: /4B7BCF043117301F1B647EF553C7F250/A326F573558AD7570F63BFC19D88739A
The ETag response header indicates the current If-Match version to use on a subsequent update.
Back to Top