Patch a related person record

patch

/RelatedPerson/{ID}

Patches an existing encounter-level or patient-level related person record.

Note: This operation supports the following authorization types:
Path Operation Value Type
/identifier/- add Identifier
  • Description: Add a new identifier for the related person.
  • Example:
    {
      "path": "/identifier/-",
      "op": "add",
      "value": {
        "type": {
          "coding": [
            {
              "code": "MR",
              "system": "http://hl7.org/fhir/v2/0203"
            }
          ]
        },
        "system": "2.16.840.1.113883.6.1000",
        "value": "<unique identifier>",
        "period": {
          "start": "2016-01-02T00:00:00-05:00",
          "end": "2020-01-02T00:00:00-05:00"
        }
      }
    }
    
  • Note:
    • Must not contain the use field.
    • Must contain the type, system, and value fields.
    • When specifying a period, the fields must include a time component with a timezone.
/identifier/{index}/id test string
  • Description:
    • Test the value of the Identifier.id of the identifier at the given {index} in the list of related person identifiers.
  • Example:
  • {
      "path": "/identifier/1/id",
      "op": "test",
      "value": "CI-490151266-1"
    }
    
/identifier/{index} remove N/A
  • Description:
    • Remove the identifier at the given {index} in the list of related person identifiers.
  • Example:
  • {
      "path": "/identifier/1",
      "op": "remove"
    }
    
  • Note:
    • Requires a test operation to be provided for the Identifier.id of the identifier intended to be removed.
    /relationship/- add CodeableConcept
    • Description
      • The nature of the relationship between a patient and the related person.
    • Example
    • [
        {
          "op": "add",
          "path": "/relationship/-",
          "value":{
            "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'
              }
            ]
          }
        }
      ]
      
  • Note:
    • When specifying a period, the fields must include a time component with a timezone.
    • Duplicate relationships may be added, but are only represented once on the resource.
    • The coding field can contain codings from the standard or proprietary system, but not both.
    • Only one coding may be provided.
    /relationship/{index}/id test string
    • Description:
      • Test the Relationship.id value of the relationship at the given {index} in the list of related person relationships.
    • Example:
    • {
        "op": "test",
        "path": "/relationship/0/id",
        "value": "CI-98278577-0"
      }
      
    /relationship/{index} remove N/A
    • Description:
      • Remove the relationship at the given {index} in the list of related person relationships.
    • Example:
    • {
        "op": "remove",
        "path": "/relationship/0"
      }
      
  • Note:
    • Requires a test operation to be provided for the Relationship.id field of the relationship to be removed.
    /relationship/{index}/extension replace Extension
    • Description:
      • Replace the relationship extension field at the given {index}.
    • Example:
    • {
        "op": "replace",
        "path": "/relationship/0/extension",
        "value": [
          {
            "valuePeriod": {
              "start": "2016-12-30T22:26:08.000Z",
              "end": "2036-12-30T22:26:08.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"
          }
        ]
      }
      
  • Note:
    • Requires a test operation to be provided for the Relationship.id of the relationship whose extension value is intended to be replaced.
    • When specifying a period, the fields must include a time component with a timezone.
    • When either start or end are not provided the value is unset.
    • The coding field can contain codings from the standard or proprietary system, but not both.
    • Only one coding may be provided.
    • If either the valuePeriod and valueCodeableConcept are not provided, any existing values for the absent period and relation extensions are removed.
    /address/- add Address
    • Description:
      • Add a new address for the related person.
    • Example:
    • {
        "op": "add",
        "path": "/address/-",
        "value": {
          "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"
          }
        }
      }
      
  • Note:
    • Must not contain the text field.
    • Must contain the use 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.
    /address/{index}/id test string
    • Description:
      • Test the Address.id value of the address at the given {index} in the list of related person addresses.
    • Example:
    • {
        "op": "test",
        "path": "/address/0/id",
        "value": "CI-24079465-0"
      }
      
    /address/{index} remove N/A
    • Description:
      • Remove the address at the given {index} in the list of related person addresses.
    • Example:
    • {
        "op": "remove",
        "path": "/address/0"
      }
      
  • Note:
    • Requires a test operation to be provided for the Address.id field of the address to be removed.
    /telecom/- add ContactPoint
    • Description:
      • Add a new contact detail for the related person.
    • Example:
    • {
        "op": "add",
        "path": "/telecom/-",
        "value": {
          "use": "home",
          "system": "email",
          "value": "test@test.com",
          "period": {
            "start": "2018-01-05T22:24:32.000Z"
          }
        }
      },
      {
        "op": "add",
        "path": "/telecom/-",
        "value": {
          "use": "home",
          "system": "phone",
          "value": "913-444-8881",
          "period": {
            "start": "2018-01-05T22:24:32.000Z"
          }
        }
      }
      
  • Note:
    • Must contain the system, use, and value fields.
    • When specifying a period, the fields must include a time component with a timezone.
    /telecom/{index}/id test string
    • Description:
      • Test the value of the ContactPoint.id of the telecom at the given {index} in the list of related person telecoms.
    • Example:
    • {
        "op": "test",
        "path": "/telecom/0/id",
        "value": "CI-PH-2807950-0"
      }
      
    /telecom/{index} remove N/A
    • Description:
      • Remove the telecom at the given {index} in the list of related person telecoms.
    • Example:
    • {
        "op": "remove"
        "path": "/telecom/0"
      }
      
  • Note:
    • Requires a test operation to be provided for the ContactPoint.id of the telecom intended to be removed.
    /name/{index}/id test string
    • Description:
      • Test the value of the HumanName.id of the name at the given {index} in the list of related person names.
    • Example:
    • {
        "op": "test",
        "path": "/name/0/id",
        "value": "CI-12467982-0"
      }
      
  • Note:
    • This operation is only supported for the first name in the list of related person names ({index} == 0).
    /name/{index}/family replace string
    • Description:
      • Replace the HumanName.family of the name at the given {index} in the list of related person names.
    • Example:
    • {
        "path": "/name/0/family",
        "op": "replace",
        "value": "Potter"
      }
      
  • Note:
    • Requires a test operation to be provided for the HumanName.id of the name whose family is intended to be replaced.
    • This operation is only supported for the first name in the list of related person names ({index} == 0).
    /name/{index}/prefix replace String
    • Description:
      • Replace the HumanName.prefix of the name at the given {index} in the list of related person names.
    • Example:
    • {
        "op": "replace",
        "path": "/name/0/prefix",
        "value": ["Mr."]
      }
      
  • Note:
    • Requires a test operation to be provided for the HumanName.id of the name whose prefix is intended to be replaced.
    • This operation is only supported for the first name in the list of related person names ({index} == 0).
    • If no prefix value is provided, the prefix on the name is unset.
    • Only one prefix value may be provided.
    /name/{index}/given replace String
    • Description:
      • Replace the HumanName.given of the name at the given {index} in the list of related person names.
    • Example:
    • {
        "path": "/name/0/given",
        "op": "replace",
        "value": [
          "Harry",
          "James"
        ]
      }
      
  • Note:
    • Requires a test operation to be provided for the HumanName.id of the name whose given name is intended to be replaced.
    • This operation is only supported for the first name in the list of related person names ({index} == 0).
    • If there are fewer values provided than the HumanName.given list currently has, the additional existing values are removed.
    • 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.
    /name/{index}/suffix replace String
    • Description:
      • Replace the HumanName.suffix of the name at the given {index} in the list of related person names.
    • Example:
    • {
        "op": "replace",
        "path": "/name/0/suffix",
        "value": ["Jr."]
      }
      
  • Note:
    • Requires a test operation to be provided for the HumanName.id of the name whose suffix is intended to be replaced.
    • This operation is only supported for the first name in the list of related person names ({index} == 0).
    • If no suffix value is provided, the suffix on the name will be unset.
    • Only one suffix value may be provided.

    Request

    Supported Media Types
    Path Parameters
    Header Parameters
    Body ()
    The body of the patch operation.
    Root Schema : RelatedPersonPatch
    Type: array
    Minimum Number of Items: 1
    A summary representation of the Patch (PATCH) operation for RelatedPerson.
    Show Source
    Nested Schema : items
    Type: object
    Show Source
    Back to Top

    Response

    Supported Media Types

    Default Response

    Example Request:
    PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/RelatedPerson/E-12467982-97731398
    Example Request Body:
    [
        {
          'op': 'add',
          'path': '/relationship/-',
          'value': {
            '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'
              }
            ]
          }
        },
        {
          'op': 'add',
          'path': '/identifier/-',
          'value': {
            'type': {
              'coding': [
                {
                  'code': 'MR',
                  'system': 'http://hl7.org/fhir/v2/0203'
                }
              ]
            },
            'system': '2.16.840.1.113883.6.1000',
            'value': 'THIS:IS:A:UNIQUE:IDENTIFIER',
            'period': {
              'start': '2016-01-02T00:00:00-05:00',
              'end': '2020-01-02T00:00:00-05:00'
            }
          }
        },
        {
          'op': 'add',
          'path': '/address/-',
          'value': {
            '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'
            }
          }
        },
        {
          "op": 'add',
          "path": '/telecom/-',
          "value": {
            "use": 'home',
            "system": 'email',
            "value": 'test@test.com',
            "period": {
              "start": '2018-01-05T22:24:32.000Z'
            }
          }
        },
        {
          "op": 'add',
          "path": '/telecom/-',
          "value": {
            "use": 'home',
            "system": 'phone',
            "value": '913-444-8881',
            "period": {
              "start": '2018-01-05T22:24:32.000Z'
            }
          }
        },
        {
          'op': 'test',
          'path': '/telecom/0/id',
          'value': 'CI-PH-29811920-0'
        },
        {
          'op': 'remove',
          'path': '/telecom/0'
        },
        {
          'op': 'test',
          'path': '/address/0/id',
          'value': 'CI-24079465-0'
        },
        {
          'op': 'remove',
          'path': '/address/0'
        },
        {
          'op': 'test',
          'path': '/relationship/0/id',
          'value': 'CI-98278577-0'
        },
        {
          'op': 'replace',
          'path': '/relationship/0/extension',
          'value': [
            {
              'valuePeriod': {
                'start': '2016-12-30T22:26:08.000Z',
                'end': '2036-12-30T22:26:08.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'
            }
          ]
        },
        {
          'op': 'test',
          'path': '/relationship/1/id',
          'value': 'CI-98909708-1'
        },
        {
          'op': 'remove',
          'path': '/relationship/1'
        },
        {
          'op': 'test',
          'path': '/name/0/id',
          'value': 'CI-12467982-0'
        },
        {
          'op': 'replace',
          'path': '/name/0/family',
          'value': 'Potter'
        },
        {
          'op': 'replace',
          'path': '/name/0/prefix',
          'value': ['Mr.']
        },
        {
          'op': 'replace',
          'path': '/name/0/given',
          'value': ['Harry', 'James']
        },
        {
          'op': 'replace',
          'path': '/name/0/suffix',
          'value': ['Jr.']
        }
      ]
    Example Response:
      Cache-Control: no-cache
      Content-Length: 0
      Content-Type: text/html
      Date: Tue, 26 Mar 2019 15:42:29 GMT
      Etag: W/"7"
      Last-Modified: Tue, 21 Jan 2020 15:57:25 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
    • 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.
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
    Back to Top