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

Patch an encounter by ID

patch

/Encounter/{ID}

Patch Operations
Path Operation Value Type
/period/start replace dateTime
  • Description: The start time of the encounter.
  • Example: 
    {
  "op": "replace",
  "path": "/period/start",
  "value":  "2015-09-01T00:00:00.000Z"
}
  • Note:
    • When no value is provided, the Encounter.period.start is unset.
    • When an Encounter.period.start value is provided, the time component should be provided.
/period/end replace dateTime
  • Description: The end time of the encounter.
  • Example: 
    {
  "op": "replace",
  "path": "/period/end",
  "value":  "2017-09-01T00:00:00.000Z"
}
  • Note:
    • When no value is provided, the Encounter.period.end is unset.
    • When an Encounter.period.end value is provided, the time component should be provided.
/type replace List of CodeableConcept
  • Description: The specific type of encounter.
  • Example: 
    {
  "op": "replace",
  "path": "/type",
  "value":  [
    {
      "coding": [
        {
          "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/71",
          "code": "309310"
        }
      ]
    }
  ]
}
  • Note:
    • The Encounter.type value should be a list.
    • When a list is provided, the first value is used to patch Encounter.type.
/extension replace List of Extension
  • Description: The array of extensions for an encounter.
  • Example: 
    • {
  "op": "replace",
  "path": "/extension",
  "value":  [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/payment-collection-status",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4003489",
            "code": "269411463",
            "display": "1st Attempt - Left Message",
            "userSelected": true
          }
        ],
        "text": "1st Attempt - Left Message"
      }
    },
    {
      'op': 'replace',
      'path': '/extension',
      'value': [
        {
          'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/estimated-financial-responsibility-amount',
          'valueMoney': {
            'value': 10.0,
            'currency': 'USD'
          }
        }
      ]
    },
    {
      'op': 'replace',
      'path': '/extension',
      'value': [
      {
        'id': 'CA-0',
        'extension': [
          {
            'id': 'ENCNTR:3339152',
            'valueString': 'Self-Pay Follow Up Date',
            'url': 'custom-attribute-name'
          },
          {
            'valueDateTime': '2018-05-01T12:00:00.000Z',
            'url': 'custom-attribute-value'
          }
        ],
        'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute'
        }
      ]
    }
  ]
}
  • Note:
/extension/- add Single Extension
  • Description: An extension for an encounter.
  • Example: 
    [
  {
    "op": "add",
    "path": "/extension/-",
    "value":  {
      "extension": [
        {
          "id": "ENCNTR:2822522",
          "valueString": "ICD-9 Code",
          "url": "custom-attribute-name"
        },
        {
          "valueString": "test string",
          "url": "custom-attribute-value"
        }
      ],
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
    }
  }
]
  • Note:

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : EncounterPatchBody
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Example Request: 
PATCH https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Encounter/97939518
Example Response: 
  Cache-Control: no-cache
  Content-Length: 0
  Content-Type: text/html
  Date: Tue, 26 Mar 2019 15:42:29 GMT
  Etag: W/"10"
  Last-Modified: Tue, 26 Mar 2019 15:42:27 GMT
  Vary: Origin
  X-Request-Id: 11111111111111111111111111111111
The ETag response header includes the current If-Match version to use on a subsequent update.
Headers
Back to Top