Jump to

• Request
• Response

Get a patient by ID

get

/Patient/{id}

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves an individual patient by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful retrieve response.

Body ()

Root Schema : Patient

Type: object

The patient demographics and administrative information returned by read and search.

Show Source

• _gender: object PrimitiveElementForPatient
• active: boolean
  Whether the patient record is active.
• address: array address
  The patient addresses.
• birthDate: string (date)
  The date of birth.
• communication: array communication
  The languages used to communicate.
• contact: array contact
  The related-person contacts.
• deceasedBoolean: boolean
  Whether the patient is deceased.
• deceasedDateTime: string (date-time)
  The date and time of death.
• extension: array extension
  The supported patient extensions.
• gender(required): string
  Allowed Values: [ "male", "female", "other", "unknown" ]

  The administrative gender.
• generalPractitioner: array generalPractitioner
  The general practitioners and organizations.
• id(required): string
  The logical ID of the patient.
• identifier(required): array identifier
  The patient and person identifiers.
• maritalStatus: object CodeableConcept
• meta: object meta
• multipleBirthBoolean: boolean
  Whether the patient is part of a multiple birth.
• multipleBirthInteger: integer
  The birth order within a multiple birth.
• name(required): array name
  The official, preferred, and premarital names.
• resourceType(required): string
  Allowed Values: [ "Patient" ]
• telecom: array telecom
  The patient contact points.
• text: object Narrative

{
    "type":"object",
    "description":"The patient demographics and administrative information returned by read and search.",
    "required":[
        "resourceType",
        "id",
        "identifier",
        "name",
        "gender"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Patient"
            ]
        },
        "id":{
            "type":"string",
            "description":"The logical ID of the patient."
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "identifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifierForPatient"
            },
            "description":"The patient and person identifiers."
        },
        "active":{
            "type":"boolean",
            "description":"Whether the patient record is active."
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            },
            "description":"The supported patient extensions."
        },
        "name":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/HumanNameForPatient"
            },
            "description":"The official, preferred, and premarital names."
        },
        "telecom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactPointForPatient"
            },
            "description":"The patient contact points."
        },
        "address":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Address"
            },
            "description":"The patient addresses."
        },
        "gender":{
            "type":"string",
            "enum":[
                "male",
                "female",
                "other",
                "unknown"
            ],
            "description":"The administrative gender."
        },
        "_gender":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "birthDate":{
            "type":"string",
            "format":"date",
            "description":"The date of birth."
        },
        "deceasedBoolean":{
            "type":"boolean",
            "description":"Whether the patient is deceased."
        },
        "deceasedDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of death."
        },
        "maritalStatus":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "multipleBirthBoolean":{
            "type":"boolean",
            "description":"Whether the patient is part of a multiple birth."
        },
        "multipleBirthInteger":{
            "type":"integer",
            "description":"The birth order within a multiple birth."
        },
        "communication":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CommunicationForPatient"
            },
            "description":"The languages used to communicate."
        },
        "contact":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactForPatient"
            },
            "description":"The related-person contacts."
        },
        "generalPractitioner":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForPatient"
            },
            "description":"The general practitioners and organizations."
        }
    }
}

Nested Schema : PrimitiveElementForPatient

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            }
        }
    }
}

Nested Schema : address

Type: array

The patient addresses.

Show Source

• Array of: object Address

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Address"
    },
    "description":"The patient addresses."
}

Nested Schema : communication

Type: array

The languages used to communicate.

Show Source

• Array of: object CommunicationForPatient

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CommunicationForPatient"
    },
    "description":"The languages used to communicate."
}

Nested Schema : contact

Type: array

The related-person contacts.

Show Source

• Array of: object ContactForPatient

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactForPatient"
    },
    "description":"The related-person contacts."
}

Nested Schema : extension

Type: array

The supported patient extensions.

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    },
    "description":"The supported patient extensions."
}

Nested Schema : generalPractitioner

Type: array

The general practitioners and organizations.

Show Source

• Array of: object ReferenceForPatient

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForPatient"
    },
    "description":"The general practitioners and organizations."
}

Nested Schema : identifier

Type: array

The patient and person identifiers.

Show Source

• Array of: object IdentifierForPatient

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IdentifierForPatient"
    },
    "description":"The patient and person identifiers."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : name

Type: array

The official, preferred, and premarital names.

Show Source

• Array of: object HumanNameForPatient

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/HumanNameForPatient"
    },
    "description":"The official, preferred, and premarital names."
}

Nested Schema : telecom

Type: array

The patient contact points.

Show Source

• Array of: object ContactPointForPatient

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactPointForPatient"
    },
    "description":"The patient contact points."
}

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    }
}

Nested Schema : ExtensionForPatient

Type: object

The FHIR extension, including supported US Core and Oracle patient extensions.

Show Source

• extension: array extension
• url: string
• valueBoolean: boolean
• valueCode: string
• valueCodeableConcept: object CodeableConceptForPatient
• valueCoding: object Coding
• valueDateTime: string (date-time)
• valueReference: object ReferenceForPatient
• valueString: string
• valueUrl: string

{
    "type":"object",
    "description":"The FHIR extension, including supported US Core and Oracle patient extensions.",
    "properties":{
        "url":{
            "type":"string"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            }
        },
        "valueCode":{
            "type":"string"
        },
        "valueString":{
            "type":"string"
        },
        "valueBoolean":{
            "type":"boolean"
        },
        "valueDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "valueUrl":{
            "type":"string"
        },
        "valueCoding":{
            "$ref":"#/components/schemas/Coding"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConceptForPatient"
        },
        "valueReference":{
            "$ref":"#/components/schemas/ReferenceForPatient"
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    }
}

Nested Schema : CodeableConceptForPatient

Type: object

Show Source

• coding: array coding
• extension: array extension
• id: string
• text: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Extension"
            }
        }
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : ReferenceForPatient

Type: object

Show Source

• display: string
• reference: string
• type: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object Extension

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Extension"
    }
}

Nested Schema : Extension

Type: object

Show Source

• url: string (uri)
• valueCode: string

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCode":{
            "type":"string"
        }
    }
}

Nested Schema : Address

Type: object

Show Source

• city: string
• country: string
• district: string
• line: array line
• period: object Period
• postalCode: string
• state: string
• text: string
• type: string
• use: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "line":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string"
        },
        "district":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "postalCode":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : line

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : CommunicationForPatient

Type: object

Show Source

• language: object CodeableConcept
• preferred: boolean

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "language":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "preferred":{
            "type":"boolean"
        }
    }
}

Nested Schema : ContactForPatient

Type: object

Show Source

• address: object Address
• gender: string
  Allowed Values: [ "male", "female", "other", "unknown" ]
• name: object HumanName
• period: object Period
• relationship: array relationship
• telecom: array telecom

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "relationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "name":{
            "$ref":"#/components/schemas/HumanName"
        },
        "telecom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactPointForPatient"
            }
        },
        "address":{
            "$ref":"#/components/schemas/Address"
        },
        "gender":{
            "type":"string",
            "enum":[
                "male",
                "female",
                "other",
                "unknown"
            ]
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : HumanName

Type: object

Show Source

• family: string
• given: array given
• period: object Period
• prefix: array prefix
• suffix: array suffix
• text: string
• use: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "family":{
            "type":"string"
        },
        "given":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "prefix":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "suffix":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : relationship

Type: array

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : telecom

Type: array

Show Source

• Array of: object ContactPointForPatient

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactPointForPatient"
    }
}

Nested Schema : given

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : prefix

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : suffix

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ContactPointForPatient

Type: object

Show Source

• _system: object PrimitiveElementForPatient
• _value: object PrimitiveElementForPatient
• extension: array extension
• period: object Period
• rank: integer
  Minimum Value: 1
• system: string
  Allowed Values: [ "phone", "fax", "email", "pager", "url", "sms", "other" ]
• use: string
  Allowed Values: [ "home", "work", "temp", "old", "mobile" ]
• value: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "system":{
            "type":"string",
            "enum":[
                "phone",
                "fax",
                "email",
                "pager",
                "url",
                "sms",
                "other"
            ]
        },
        "_system":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "value":{
            "type":"string"
        },
        "_value":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "use":{
            "type":"string",
            "enum":[
                "home",
                "work",
                "temp",
                "old",
                "mobile"
            ]
        },
        "rank":{
            "type":"integer",
            "minimum":1
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForPatient"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForPatient
  The FHIR extension, including supported US Core and Oracle patient extensions.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForPatient"
    }
}

Nested Schema : IdentifierForPatient

Type: object

Show Source

• _system: object PrimitiveElementForPatient
• _value: object PrimitiveElementForPatient
• period: object Period
• system: string
• type: object CodeableConcept
• use: string
• value: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "system":{
            "type":"string"
        },
        "_system":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "value":{
            "type":"string"
        },
        "_value":{
            "$ref":"#/components/schemas/PrimitiveElementForPatient"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : HumanNameForPatient

Type: object

Show Source

• extension: array extension
• family: string
• given: array given
• period: object Period
• prefix: array prefix
• suffix: array suffix
• text: string
• use: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "family":{
            "type":"string"
        },
        "given":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "prefix":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "suffix":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Extension"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object Extension

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Extension"
    }
}

Nested Schema : given

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : prefix

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : suffix

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top