FHIR R4 APIs for Oracle Health Millennium Platform

Create a related person record

post

/RelatedPerson

Creates a new encounter-level or patient-level related person record.

Note:

Only the body fields mentioned below are supported. Unsupported fields are ignored, or can result in errors.

This operation supports the following authorization types:

Request

Supported Media Types

application/fhir+json

Header Parameters

Authorization(required): string

Contains the credentials to authenticate a consumer to the service. The credentials should be the OAuth2 Bearer Token.
accept(required): string

The media type to be requested. See what the resource's operation produces for what is supported.

The body of the create operation.

Root Schema : RelatedPersonCreate

Type: object

A summary representation of the Create (POST) operation for RelatedPerson.

Show Source

active: boolean
Whether this related person record is in active use.
Note: If set, the value must be true. Example:
```
{
  "active": true
}
```

address: string

Addresses for the individual.

Note:

Each address must contain the use field.
Each address must not contain the text field.
When specifying a period, the fields must include a time component with a timezone.
If line is provided, only the first four values are used. Additional values are ignored.

Example:

{
  "address": [
    {
      "use": "home",
      "line": [
         "1212 Faircastle Drive",
         "Apartment 406"
      ],
      "city": "KC",
      "district": "Jackson",
      "state": "KS",
      "postalCode": "64199",
      "country": "United States of America",
      "period": {
        "start": "2012-05-17T15:33:18.000Z"
      }
    }
  ]
}

birthDate: string
The date of birth for the individual.
Example:
```
{
  "birthDate": "1990-09-15"
}
```

communication:

Language which may be used to communicate with the related person.

Note:

Only one communication may be provided.
communication.prefered if provided should be true.

Example:

{
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "urn:ietf:bcp:47",
          "code": "en",
            "display": "English"
          }
        ]
      },
      "preferred": true
    }
  ]
}

gender: string
Administrative gender is the gender that the related person is considered to have for administration and record keeping purposes.
Example:
```
{
  "gender": "male"
}
```

identifier: string

The identifiers for the related person.

Note:

Each identifier must not contain the use fields.
Each identifier must contain the type, system, and value fields.
When specifying a period, the fields must include a time component with a timezone.

Example:

{
  "identifier": [
    {
      "type": {
        "coding": [
          {
            "code": "MR",
            "system": "http://hl7.org/fhir/v2/0203"
          }
        ]
      },
      "system": "urn:oid:5.5.5.5.5.5",
      "value": "<UNIQUE IDENTIFIER>",
      "period": {
        "start": "2016-01-02T00:00:00-05:00",
        "end": "2020-01-02T00:00:00-05:00"
      }
    }
  ]
}

name(required): string
The name associated with the individual.
Note:
- Exactly one name must be provided. The provided name must meet the following conditions:
  - Must have a use of 'official'.
  - Cannot contain the text field.
  - Must contain either the given or family fields.
  - Up to two given names may be provided. If additional given names are required they must be provided in the second value as a single string separated by blank spaces.
  - Only one prefix and one suffix may be provided.
  - period.end is not supported.
  - When specifying a period, the fields must include a time component with a timezone.
Example:
```
{
  "name": [
    {
      "use": "official",
      "family": "Doe",
      "given": [
        "John",
        "Smith"
      ],
      "period": {
        "start": "2010-05-17T14:54:31.000Z"
      }
    }
  ]
}
```
patient(required): object patient
Patient that the individual is related to for the encounter-level RelatedPerson.
Example:
```
{
  "patient": {
    "reference": "Patient/12724066"
  }
}
```

A reference to an encounter.

Note:

The valueReference.reference must be an encounter reference.

Example:

{
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/related-person-encounter",
      "valueReference": {
        "reference": "Encounter/97939518"
      }
    }
  ]
}

relationship(required): object relationship

The nature of the relationship between a patient and the related person.

Note:

When specifying a period, the fields must include a time component with a timezone.
The coding field can contain codings from the standard or proprietary system, but not both.
Only one coding may be provided.

Example:

{
  "relationship": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "FAMMEMB"
        }
      ]
    }
    {
      "extension": [
        {
          "valuePeriod": {
            "start": "2016-12-19T16:44:25.000Z",
            "end": "2022-05-01T16:56:56.000Z"
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
        },
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "SIS"
              }
            ]
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
        }
      ]
    }
  ]
}

Relationship Level: object Relationship Level

The resource's relationship to either the patient or encounter level.

Note:

The valueCodeableConcept.coding[0].code can be Encounter or Patient.

Example:

{
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Encounter",
          }
        ]
      }
    }
  ]
}

resourceType(required): string

Allowed Values: [ "RelatedPerson" ]

The type of the FHIR resource.

telecom: string

A contact detail, for example, a telephone number or an email address, by which the individual may be contacted.

Note:

Each telecom must contain the system, use, and value fields.
System must be a phone or an email.
When specifying a period, the fields must include a time component with a timezone.

Example:

{
  "telecom": [
    {
      "system": "phone",
      "value": "8168229121",
      "use": "home",
      "period": {
        "start": "2012-05-17T15:33:18.000Z"
      }
    },
    {
      "system": "email",
      "value": "testemail@example.com",
      "use": "home",
      "period": {
        "start": "2008-01-10T15:33:18.000Z"
      }
    }
  ]
}

{
    "description":"A summary representation of the Create (POST) operation for RelatedPerson.",
    "type":"object",
    "required":[
        "resourceType",
        "relationship",
        "patient",
        "name"
    ],
    "properties":{
        "resourceType":{
            "description":"The type of the FHIR resource.\n",
            "type":"string",
            "enum":[
                "RelatedPerson"
            ]
        },
        "relationship":{
            "description":"<p>The nature of the relationship between a patient and the related person.</p>\n\nNote:\n<ul>\n  <li> When specifying a <code>period</code>, the fields must include a time component with a timezone. </li>\n  <li> The <code>coding</code> field can contain codings from the standard or proprietary system, but not both. </li>\n  <li> Only one <code>coding</code> may be provided. </li>\n</ul>\n\n\nExample:\n\n<pre><code>{\n  \"relationship\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n          \"code\": \"FAMMEMB\"\n        }\n      ]\n    }\n    {\n      \"extension\": [\n        {\n          \"valuePeriod\": {\n            \"start\": \"2016-12-19T16:44:25.000Z\",\n            \"end\": \"2022-05-01T16:56:56.000Z\"\n          },\n          \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/period\"\n        },\n        {\n          \"valueCodeableConcept\": {\n            \"coding\": [\n              {\n                \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n                \"code\": \"SIS\"\n              }\n            ]\n          },\n          \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/relation\"\n        }\n      ]\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"object",
            "properties":{
                "text":{
                    "type":"string"
                },
                "coding":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "system":{
                                "type":"string"
                            },
                            "code":{
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "patient":{
            "description":"<p>Patient that the individual is related to for the encounter-level RelatedPerson.</p>\nExample:\n\n<pre><code>{\n  \"patient\": {\n    \"reference\": \"Patient/12724066\"\n  }\n}\n\n</pre></code>\n",
            "type":"object",
            "properties":{
                "reference":{
                    "type":"string"
                }
            }
        },
        "name":{
            "description":"<p>The name associated with the individual.</p>\n\nNote:\n<ul>\n  <li> Exactly one name must be provided. The provided name must meet the following conditions:\n    <ul>\n      <li> Must have a <code>use</code> of 'official'. </li>\n      <li> Cannot contain the <code>text</code> field. </li>\n      <li> Must contain either the <code>given</code> or <code>family</code> fields. </li>\n      <li> Up to two <code>given</code> names may be provided. If additional given names are required they must be provided in the second value as a single string separated by blank spaces. </li>\n      <li> Only one <code>prefix</code> and one <code>suffix</code> may be provided. </li>\n      <li> <code>period.end</code> is not supported. </li>\n      <li> When specifying a <code>period</code>, the fields must include a time component with a timezone. </li>\n    </ul>\n  </li>\n</ul>\n\n\nExample:\n\n<pre><code>\n{\n  \"name\": [\n    {\n      \"use\": \"official\",\n      \"family\": \"Doe\",\n      \"given\": [\n        \"John\",\n        \"Smith\"\n      ],\n      \"period\": {\n        \"start\": \"2010-05-17T14:54:31.000Z\"\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"string"
        },
        "Related Person Encounter":{
            "description":"<p>A reference to an encounter.</p>\n\nNote:\n<ul>\n  <li>The <code>valueReference.reference</code> must be an encounter reference.</li>\n</ul>\n\n\nExample:\n\n<pre><code>{\n  \"extension\": [\n    {\n      \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/related-person-encounter\",\n      \"valueReference\": {\n        \"reference\": \"Encounter/97939518\"\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"object",
            "properties":{
                "url":{
                    "type":"string"
                }
            }
        },
        "Relationship Level":{
            "description":"<p>The resource's relationship to either the patient or encounter level.</p>\n\nNote:\n<ul>\n  <li> The <code>valueCodeableConcept.coding[0].code</code> can be <a target=\"_blank\" href=\"https://hl7.org/fhir/R4/encounter.html\"><code>Encounter</code></a> or <a target=\"_blank\" href=\"https://hl7.org/fhir/R4/patient.html\"><code>Patient</code></a>. </li>\n</ul>\n\n\nExample:\n\n<pre><code>{\n  \"extension\": [\n    {\n      \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level\",\n      \"valueCodeableConcept\": {\n        \"coding\": [\n          {\n            \"system\": \"http://hl7.org/fhir/resource-types\",\n            \"code\": \"Encounter\",\n          }\n        ]\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"object",
            "properties":{
                "url":{
                    "type":"string"
                }
            }
        },
        "identifier":{
            "description":"<p>The identifiers for the related person.</p>\n\nNote:\n<ul>\n    <li> Each identifier must not contain the <code>use</code> fields. </li>\n    <li> Each identifier must contain the <code>type</code>, <code>system</code>, and <code>value</code> fields. </li>\n    <li> When specifying a <code>period</code>, the fields must include a time component with a timezone. </li>\n</ul>\n\n\nExample:\n\n<pre><code>{\n  \"identifier\": [\n    {\n      \"type\": {\n        \"coding\": [\n          {\n            \"code\": \"MR\",\n            \"system\": \"http://hl7.org/fhir/v2/0203\"\n          }\n        ]\n      },\n      \"system\": \"urn:oid:5.5.5.5.5.5\",\n      \"value\": \"&lt;UNIQUE IDENTIFIER&gt;\",\n      \"period\": {\n        \"start\": \"2016-01-02T00:00:00-05:00\",\n        \"end\": \"2020-01-02T00:00:00-05:00\"\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"string"
        },
        "address":{
            "description":"<p>Addresses for the individual.</p>\n\nNote:\n<ul>\n  <li> Each address must contain the <code>use</code> field. </li>\n  <li> Each address must not contain the <code>text</code> field. </li>\n  <li> When specifying a <code>period</code>, the fields must include a time component with a timezone. </li>\n  <li> If <code>line</code> is provided, only the first four values are used. Additional values are ignored. </li>\n</ul>\n\n\nExample:\n\n<pre><code>{\n  \"address\": [\n    {\n      \"use\": \"home\",\n      \"line\": [\n         \"1212 Faircastle Drive\",\n         \"Apartment 406\"\n      ],\n      \"city\": \"KC\",\n      \"district\": \"Jackson\",\n      \"state\": \"KS\",\n      \"postalCode\": \"64199\",\n      \"country\": \"United States of America\",\n      \"period\": {\n        \"start\": \"2012-05-17T15:33:18.000Z\"\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"string"
        },
        "telecom":{
            "description":"<p>A contact detail, for example, a telephone number or an email address, by which the individual may be contacted.</p>\n\nNote:\n<ul>\n  <li> Each telecom must contain the <code>system</code>, <code>use</code>, and <code>value</code> fields. </li>\n  <li> System must be a <code>phone</code> or an <code>email</code>. </li>\n  <li> When specifying a <code>period</code>, the fields must include a time component with a timezone. </li>\n</ul>\n\n\nExample:\n\n<pre><code>{\n  \"telecom\": [\n    {\n      \"system\": \"phone\",\n      \"value\": \"8168229121\",\n      \"use\": \"home\",\n      \"period\": {\n        \"start\": \"2012-05-17T15:33:18.000Z\"\n      }\n    },\n    {\n      \"system\": \"email\",\n      \"value\": \"testemail@example.com\",\n      \"use\": \"home\",\n      \"period\": {\n        \"start\": \"2008-01-10T15:33:18.000Z\"\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"string"
        },
        "active":{
            "description":"<p>Whether this related person record is in active use.</p>\n\nNote:\nIf set, the value must be true.\n\nExample:\n<pre><code>{\n  \"active\": true\n}\n\n</pre></code>\n",
            "type":"boolean"
        },
        "gender":{
            "description":"<p>Administrative gender is the gender that the related person is considered to have for administration and record keeping purposes.</p>\nExample:\n\n<pre><code>{\n  \"gender\": \"male\"\n}\n\n</pre></code>\n",
            "type":"string"
        },
        "birthDate":{
            "description":"<p>The date of birth for the individual.</p>\nExample:\n\n<pre><code>{\n  \"birthDate\": \"1990-09-15\"\n}\n\n</pre></code>\n",
            "type":"string"
        },
        "communication":{
            "description":"<p>Language which may be used to communicate with the related person.</p>\n\nNote:\n<ul>\n  <li> Only one communication may be provided. </li>\n  <li> <code>communication.prefered</code> if provided should be <code>true</code>. </li>\n</ul>\n\n\nExample:\n\n<pre><code>{\n  \"communication\": [\n    {\n      \"language\": {\n        \"coding\": [\n          {\n            \"system\": \"urn:ietf:bcp:47\",\n          \"code\": \"en\",\n            \"display\": \"English\"\n          }\n        ]\n      },\n      \"preferred\": true\n    }\n  ]\n}\n\n</pre></code>\n"
        }
    }
}

Nested Schema : patient

Type: object

Patient that the individual is related to for the encounter-level RelatedPerson.

Example:

{
  "patient": {
    "reference": "Patient/12724066"
  }
}

Show Source

reference: string

{
    "description":"<p>Patient that the individual is related to for the encounter-level RelatedPerson.</p>\nExample:\n\n<pre><code>{\n  \"patient\": {\n    \"reference\": \"Patient/12724066\"\n  }\n}\n\n</pre></code>\n",
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        }
    }
}

Nested Schema : Related Person Encounter

Type: object

A reference to an encounter.

Note:

The valueReference.reference must be an encounter reference.

Example:

{
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/related-person-encounter",
      "valueReference": {
        "reference": "Encounter/97939518"
      }
    }
  ]
}

Show Source

url: string

{
    "description":"<p>A reference to an encounter.</p>\n\nNote:\n<ul>\n  <li>The <code>valueReference.reference</code> must be an encounter reference.</li>\n</ul>\n\n\nExample:\n\n<pre><code>{\n  \"extension\": [\n    {\n      \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/related-person-encounter\",\n      \"valueReference\": {\n        \"reference\": \"Encounter/97939518\"\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
    "type":"object",
    "properties":{
        "url":{
            "type":"string"
        }
    }
}

Nested Schema : relationship

Type: object

The nature of the relationship between a patient and the related person.

Note:

When specifying a period, the fields must include a time component with a timezone.
The coding field can contain codings from the standard or proprietary system, but not both.
Only one coding may be provided.

Example:

{
  "relationship": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "FAMMEMB"
        }
      ]
    }
    {
      "extension": [
        {
          "valuePeriod": {
            "start": "2016-12-19T16:44:25.000Z",
            "end": "2022-05-01T16:56:56.000Z"
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/period"
        },
        {
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "SIS"
              }
            ]
          },
          "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relation"
        }
      ]
    }
  ]
}

Show Source

coding: array coding
text: string

{
    "description":"<p>The nature of the relationship between a patient and the related person.</p>\n\nNote:\n<ul>\n  <li> When specifying a <code>period</code>, the fields must include a time component with a timezone. </li>\n  <li> The <code>coding</code> field can contain codings from the standard or proprietary system, but not both. </li>\n  <li> Only one <code>coding</code> may be provided. </li>\n</ul>\n\n\nExample:\n\n<pre><code>{\n  \"relationship\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n          \"code\": \"FAMMEMB\"\n        }\n      ]\n    }\n    {\n      \"extension\": [\n        {\n          \"valuePeriod\": {\n            \"start\": \"2016-12-19T16:44:25.000Z\",\n            \"end\": \"2022-05-01T16:56:56.000Z\"\n          },\n          \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/period\"\n        },\n        {\n          \"valueCodeableConcept\": {\n            \"coding\": [\n              {\n                \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n                \"code\": \"SIS\"\n              }\n            ]\n          },\n          \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/relation\"\n        }\n      ]\n    }\n  ]\n}\n\n</pre></code>\n",
    "type":"object",
    "properties":{
        "text":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "system":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : Relationship Level

Type: object

The resource's relationship to either the patient or encounter level.

Note:

The valueCodeableConcept.coding[0].code can be Encounter or Patient.

Example:

{
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Encounter",
          }
        ]
      }
    }
  ]
}

Show Source

url: string

{
    "description":"<p>The resource's relationship to either the patient or encounter level.</p>\n\nNote:\n<ul>\n  <li> The <code>valueCodeableConcept.coding[0].code</code> can be <a target=\"_blank\" href=\"https://hl7.org/fhir/R4/encounter.html\"><code>Encounter</code></a> or <a target=\"_blank\" href=\"https://hl7.org/fhir/R4/patient.html\"><code>Patient</code></a>. </li>\n</ul>\n\n\nExample:\n\n<pre><code>{\n  \"extension\": [\n    {\n      \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level\",\n      \"valueCodeableConcept\": {\n        \"coding\": [\n          {\n            \"system\": \"http://hl7.org/fhir/resource-types\",\n            \"code\": \"Encounter\",\n          }\n        ]\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
    "type":"object",
    "properties":{
        "url":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "system":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

code: string
system: string

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/fhir+json

Default Response

Example create request and response for a patient-level related person record.

Example Request:

POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson

Example Request Body:

{
    'resourceType': 'RelatedPerson',
    'extension': [
      {
        'valueCodeableConcept': {
          'coding': [
            {
              'system': 'http://hl7.org/fhir/resource-types',
              'code': 'Patient'
            }
          ]
        },
        'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level'
      }
    ],
    'identifier': [
      {
        'type': {
          'coding': [
            {
              'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4',
              'code': '22'
            }
          ]
        },
        'system': 'urn:oid:2.16.840.1.113883.3.42.10001.100001.12',
        'value': '1000000105'
      }
    ],
    'active': true,
    'patient': {
      'reference': 'Patient/12724068'
    },
    'relationship': [
      {
        'extension': [
          {
            'valuePeriod': {
              'start': '2019-12-26T16:06:26.000Z'
            },
            'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/period'
          },
          {
            'valueCodeableConcept': {
              'coding': [
                {
                  'system': 'http://terminology.hl7.org/CodeSystem/v3-RoleCode',
                  'code': 'MTH'
                }
              ]
            },
            'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/relation'
          }
        ],
        'coding': [
          {
            'system': 'http://terminology.hl7.org/CodeSystem/v3-RoleCode',
            'code': 'GT'
          }
        ]
      }
    ],
    'name': [
      {
        'use': 'official',
        'family': 'SMART',
        'given': [
          'NANCY'
        ],
        'period': {
          'start': '2019-12-26T15:12:34.000Z'
        }
      }
    ],
    'telecom': [
      {
        'extension': [
          {
            'valueUrl': '13215555555',
            'url': 'http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address'
          }
        ],
        'system': 'phone',
        'value': '13215555555',
        'use': 'work',
        'period': {
          'start': '2021-03-22T14:12:37.000Z'
        }
      }
    ],
    'gender': 'female',
    'birthDate': '1980-08-11',
    'address': [
      {
        'use': 'home',
        'line': [
          '3P'
        ],
        'city': 'KANSAS CITY',
        'district': 'Jackson',
        'state': 'MO',
        'postalCode': '641510001',
        'country': 'US',
        'period': {
          'start': '2020-12-08T15:05:44.000Z'
        }
      }
    ],
    'communication': [
      {
        'language': {
          'coding': [
            {
              'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/36',
              'code': '151'
            },
            {
              'system': 'urn:ietf:bcp:47',
              'code': 'en'
            }
          ]
        },
        'preferred': 'true'
      }
    ]
  }

Example Response:

  Cache-Control: no-cache
  Content-Length: 0
  Content-Type: text/html
  Date: Fri, 16 Jul 2021 17:23:14 GMT
  Etag: W/"0"
  Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/12724066-12724068
  Last-Modified: Fri, 16 Jul 2021 17:23:13 GMT
  Vary: Origin
  X-Request-Id: 11111111-1111-1111-1111-111111111111
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on a subsequent update.

Headers

Etag: string

For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
X-Request-Id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-create-encounter-level Response

Example create request and response for an encounter-level related person record.

Example Request:

POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson

Example Request Body:

{
    'resourceType': 'RelatedPerson',
    'extension': [
      {
        'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/related-person-encounter',
        'valueReference': {
          'reference': 'Encounter/97939518'
        }
      },
      {
        'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/relationship-level',
        'valueCodeableConcept': {
          'coding': [
            {
              'system': 'http://hl7.org/fhir/resource-types',
              'code': 'Encounter'
            }
          ]
        }
      }
    ],
    'patient': {
      'reference': 'Patient/12724066'
    },
    'relationship': [
      {
        'coding': [
          {
            'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/351',
            'code': '1152',
            'display': 'Emergency Contact'
          }
        ],
        'extension': [
          {
            'valuePeriod': {
              'start': '2016-12-19T16:44:25.000Z',
              'end': '2022-05-01T16:56:56.000Z'
            },
            'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/period'
          },
          {
            'valueCodeableConcept': {
              'coding': [
                {
                  'system': 'http://terminology.hl7.org/CodeSystem/v3-RoleCode',
                  'code': 'SIS'
                }
              ]
            },
            'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/relation'
          }
        ]
      }
    ],
    'name': [
      {
        'use': 'official',
        'family': 'Doe',
        'given': [
          'John',
          'Smith'
        ],
        'period': {
          'start': '2010-05-17T14:54:31.000Z'
        }
      }
    ],
    'communication': [
      {
        'language': {
          'coding': [
            {
              'system': 'urn:ietf:bcp:47',
              'code': 'en',
              'display': 'English'
            }
          ]
        },
        'preferred': true
      }
    ],
    'identifier': [
      {
        'type': {
          'coding': [
            {
              'code': 'AN',
              'system': 'http://terminology.hl7.org/CodeSystem/v2-0203'
            }
          ]
        },
        'system': 'urn:oid:5.5.5.5.5.5',
        'value': '',
        'period': {
          'start': '2016-01-02T00:00:00-05:00',
          'end': '2020-01-02T00:00:00-05:00'
        }
      }
    ],
    'address': [
      {
        'use': 'home',
        'line': [
          '1212 Faircastle Drive',
          'Apartment 406'
        ],
        'city': 'KC',
        'district': 'Jackson',
        'state': 'KS',
        'postalCode': '64199',
        'country': 'United States of America',
        'period': {
          'start': '2012-05-17T15:33:18.000Z'
        }
      }
    ],
    'gender': 'male',
    'birthDate': '1990-09-15',
    'telecom': [
      {
        'system': 'phone',
        'value': '8168229121',
        'use': 'home',
        'period': {
          'start': '2012-05-17T15:33:18.000Z'
        }
      },
      {
        'system': 'email',
        'value': 'testemail@example.com',
        'use': 'home',
        'period': {
          'start': '2008-01-10T15:33:18.000Z'
        }
      }
    ]
  }

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/RelatedPerson/E-12747484-97939518
  Last-Modified: Thu, 17 Dec 2020 16:37:42 GMT
  Vary: Origin
  X-Request-Id: 11111111-1111-1111-1111-111111111111
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on a subsequent update.

Headers

Etag: string

For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
X-Request-Id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.