Patient REST Endpoints

Sort by

Task Path Method

Description

Patient

This topic describes information for the Patient resource.

Overview

The Patient resource provides general demographic information about a person receiving healthcare services from a specific organization. Common demographic fields include patient ID, patient name, gender, date of birth, address, phone number, primary language, and marital status. Additional concepts returned as extensions and not part of the base resource include time of birth, preferred contact, race, ethnicity, and birth sex. Oracle Health Millennium Platform is a patient-centric application; thus, many other resources include the patient ID in their queries. A person receiving care from multiple organizations may have data available in multiple patient resources in multiple FHIR servers.

This resource supports the US Core Patient Profile from HL7 FHIR US Core Implementation Guide STU 6.1.0.

The following fields are returned if valued:

• Patient id
• Patient Identifier
• Active
• Patient name
• Telecom Information (may include phone and email)
• Gender (administrative)
• Extensions including birth time, preferred contact, birth sex, ethnicity, communication preference, and race (for more information, see the Extensions section of this topic)
• Date of Birth

• Deceased

  • Boolean
  • dateTime
• Address
• Marital status

• Multiple Birth Information

  • Boolean
  • Integer
• Contact person (guardian, parent or emergency)
• Communication (preferred language)

• Primary Care Providers

  • Reference (Practitioner)

Terminology Bindings

• Patient.identifier.type

  Description: The type used to determine which identifier to use for a specific purpose.

  • Details: Identifier Type Codes

    System: http://hl7.org/fhir/identifier-type

  • Details: v2 Identifier Type

    System: http://terminology.hl7.org/CodeSystem/v2-0203

  • Details: For more information, see Code Set 4 Person Identifier (Alias) Types under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/{EHR source ID}/codeSet/4

• Patient.maritalStatus

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

  • Details: Marital Status Codes

    System: http://hl7.org/fhir/marital-status

  • Details: v3.MaritalStatus

    System: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus

  • Details: v3.NullFlavor

    System: http://terminology.hl7.org/CodeSystem/v3-NullFlavor

  • Details: For more information, see Code Set 38 Marital Status under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/{EHR source ID}/codeSet/38

• Patient.contact.relationship

  Description: The nature of the relationship between a patient and a contact person for that patient.

  • Details: PatientContactRelationship

    System: http://hl7.org/fhir/patient-contactrelationship

  • Details: v2.0131

    System: http://terminology.hl7.org/CodeSystem/v2-0131

  • Details: For more information, see Code Set 351 Person Relationship Types under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/{EHR source ID}/codeSet/351

• Patient.communication.language

  Description: The language that may be used to communicate with the patient about their health.

  • Details: CommonLanguages

    System: http://hl7.org/fhir/languages

  • Details: IETF Identifying Languages

    System: urn:ietf:bcp:47

  • Details:

    System:

  • Details: For more information, see Code Set 36 Languages under the List of Code Sets section in Proprietary Codes and Systems.

    System: https://fhir.cerner.com/{EHR source ID}/codeSet/36

Extensions

• Patient Birth Time

• Patient Preferred Contact

• US Core Race

• US Core Ethnicity

• US Core Birth Sex

• US Core Gender Identity
• US Core Sex
• US Core Tribal Affiliation

• Communication Preference

Patient

The operations from the Patient category.

Create a patient

Method: post

Path: /Patient

Get a list of patients

Method: get

Path: /Patient

Get a patient by ID

Method: get

Path: /Patient{ID}

Patch a patient

Method: patch

Path: /Patient{ID}