Jump to

• Request
• Response

Get a list of patients

get

/Patient

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of patients that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• birthdate: string
  The patient's date of birth.
• gender: string
  The gender of the patient.
• identifier: string
  A patient identifier.
• name: string
  A server-defined search that may match any of the string fields in the HumanName.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/Patient"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/Patient"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

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

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object Patient
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/Patient"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : Patient

Type: object

Show Source

• address: array address
  (USCDI) An address for the individual.
• birthDate: string (date)
  (USCDI) The date of birth for the individual.
• communication: array communication
  (USCDI) A language that may be used to communicate with the patient about their health.
• gender(required): string
  (USCDI) The following values are supported:

  • male
  • female
  • other
  • unknown
• id(required): string
• identifier(required): array identifier
  (USCDI) An identifier for this patient.
• name(required): array name
  (USCDI) A name associated with the patient.
• resourceType(required): string
  Allowed Values: [ "Patient" ]
• telecom: array telecom
  (USCDI) A contact detail for the individual.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "identifier",
        "name",
        "gender"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Patient"
            ]
        },
        "id":{
            "type":"string"
        },
        "identifier":{
            "type":"array",
            "description":"(USCDI) An identifier for this patient.",
            "items":{
                "$ref":"#/components/schemas/Identifier"
            }
        },
        "name":{
            "type":"array",
            "description":"(USCDI) A name associated with the patient.",
            "items":{
                "$ref":"#/components/schemas/HumanName"
            }
        },
        "telecom":{
            "type":"array",
            "description":"(USCDI) A contact detail for the individual.",
            "items":{
                "$ref":"#/components/schemas/ContactPointRequired"
            }
        },
        "gender":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n  <ul>\n    <li><code>male</code></li>\n    <li><code>female</code></li>\n    <li><code>other</code></li>\n    <li><code>unknown</code></li>\n  </ul>\n"
        },
        "birthDate":{
            "type":"string",
            "format":"date",
            "description":"(USCDI) The date of birth for the individual."
        },
        "address":{
            "type":"array",
            "description":"(USCDI) An address for the individual.",
            "items":{
                "$ref":"#/components/schemas/Address"
            }
        },
        "communication":{
            "type":"array",
            "description":"(USCDI) A language that may be used to communicate with the patient about their health.",
            "items":{
                "$ref":"#/components/schemas/PatientCommunication"
            }
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : address

Type: array

(USCDI) An address for the individual.

Show Source

• Array of: object Address

{
    "type":"array",
    "description":"(USCDI) An address for the individual.",
    "items":{
        "$ref":"#/components/schemas/Address"
    }
}

Nested Schema : communication

Type: array

(USCDI) A language that may be used to communicate with the patient about their health.

Show Source

• Array of: object PatientCommunication

{
    "type":"array",
    "description":"(USCDI) A language that may be used to communicate with the patient about their health.",
    "items":{
        "$ref":"#/components/schemas/PatientCommunication"
    }
}

Nested Schema : identifier

Type: array

(USCDI) An identifier for this patient.

Show Source

• Array of: object Identifier

{
    "type":"array",
    "description":"(USCDI) An identifier for this patient.",
    "items":{
        "$ref":"#/components/schemas/Identifier"
    }
}

Nested Schema : name

Type: array

(USCDI) A name associated with the patient.

Show Source

• Array of: object HumanName

{
    "type":"array",
    "description":"(USCDI) A name associated with the patient.",
    "items":{
        "$ref":"#/components/schemas/HumanName"
    }
}

Nested Schema : telecom

Type: array

(USCDI) A contact detail for the individual.

Show Source

• Array of: object ContactPointRequired

{
    "type":"array",
    "description":"(USCDI) A contact detail for the individual.",
    "items":{
        "$ref":"#/components/schemas/ContactPointRequired"
    }
}

Nested Schema : Address

Type: object

Show Source

• city: string
  The name of city, town, and so on.
• country: string
  The country, which can be the International Organization for Standardization (ISO) 3166 two-letter or three-letter code.
• line: array line
  The street name, number, direction, P.O. Box, and so on.
• postalCode: string
  The U.S. ZIP Codes.
• state: string
  The subunit of the country (abbreviations are supported).

{
    "type":"object",
    "properties":{
        "line":{
            "type":"array",
            "description":"The street name, number, direction, P.O. Box, and so on.",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string",
            "description":"The name of city, town, and so on."
        },
        "state":{
            "type":"string",
            "description":"The subunit of the country (abbreviations are supported)."
        },
        "postalCode":{
            "type":"string",
            "description":"The U.S. ZIP Codes."
        },
        "country":{
            "type":"string",
            "description":"The country, which can be the International Organization for Standardization (ISO) 3166 two-letter or three-letter code."
        }
    }
}

Nested Schema : line

Type: array

The street name, number, direction, P.O. Box, and so on.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The street name, number, direction, P.O. Box, and so on.",
    "items":{
        "type":"string"
    }
}

Nested Schema : PatientCommunication

Type: object

Show Source

• language(required): language
  (USCDI) The language that can be used to communicate with the patient about their health.

{
    "type":"object",
    "required":[
        "language"
    ],
    "properties":{
        "language":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The language that can be used to communicate with the patient about their health."
        }
    }
}

Nested Schema : language

(USCDI) The language that can be used to communicate with the patient about their health.

Match All

(USCDI) The language that can be used to communicate with the patient about their health.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The language that can be used to communicate with the patient about their health."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

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

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

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

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : Identifier

Type: object

Show Source

• system(required): string (uri)
• value(required): string

{
    "type":"object",
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : HumanName

Type: object

Show Source

• family(required): string
  The family name (often called the surname).

{
    "type":"object",
    "required":[
        "family"
    ],
    "properties":{
        "family":{
            "type":"string",
            "description":"The family name (often called the surname)."
        }
    }
}

Nested Schema : ContactPointRequired

Type: object

Show Source

• system(required): string
  (USCDI) The following values are supported:

  • phone
  • fax
  • email
  • pager
  • url
  • sms
  • other
• use: string

  (USCDI) The purpose of this contact point.

  The following values are supported:

  • home
  • work
  • temp
  • old
  • mobile

• value(required): string
  (USCDI) The actual contact point details.

{
    "type":"object",
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n<ul>\n  <li><code>phone</code></li>\n  <li><code>fax</code></li>\n  <li><code>email</code></li>\n  <li><code>pager</code></li>\n  <li><code>url</code></li>\n  <li><code>sms</code></li>\n  <li><code>other</code></li>\n</ul>\n"
        },
        "value":{
            "type":"string",
            "description":"(USCDI) The actual contact point details."
        },
        "use":{
            "type":"string",
            "description":"<p>(USCDI) The purpose of this contact point.</p>\n<p>The following values are supported:\n  <ul>\n    <li><code>home</code></li>\n    <li><code>work</code></li>\n    <li><code>temp</code></li>\n    <li><code>old</code></li>\n    <li><code>mobile</code></li>\n  </ul></p>\n"
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top