Jump to

• Request
• Response

Get a list of persons

get

/Person

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 a list of persons that meet the supplied query parameters.

• Provide _id or identifier.
• Use _lastUpdated only with identifier.

Request

Query Parameters

• _count: integer
  Minimum Value: 1

  Maximum Value: 128

  The maximum number of results per page.
• _id: string
  The logical resource ID.
• _lastUpdated: array[string]
  Maximum Number of Items: 2

  The last updated date or range.
• identifier: string
  One system|value token.

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 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" ]
• total: integer
  The number of person match entries on this page.
• 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":{
                "$ref":"#/components/schemas/BundleEntryForPerson"
            }
        },
        "total":{
            "type":"integer",
            "description":"The number of person match entries on this page."
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object BundleEntryForPerson

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

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

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

Nested Schema : BundleEntryForPerson

Type: object

Show Source

• fullUrl: string
• resource: object Person
  The person demographics and links to associated patient or practitioner personas.
• search: object BundleEntrySearch

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "fullUrl":{
            "type":"string"
        },
        "resource":{
            "$ref":"#/components/schemas/Person"
        },
        "search":{
            "$ref":"#/components/schemas/BundleEntrySearch"
        }
    }
}

Nested Schema : Person

Type: object

The person demographics and links to associated patient or practitioner personas.

Show Source

• active: boolean
• address: array address
• birthDate: string (date)
• gender: string
  Allowed Values: [ "male", "female", "other", "unknown" ]
• id(required): string
• identifier: array identifier
• link: array link
• meta: object meta
• name: array name
• resourceType(required): string
  Allowed Values: [ "Person" ]
• telecom: array telecom
• text: object Narrative

{
    "type":"object",
    "description":"The person demographics and links to associated patient or practitioner personas.",
    "required":[
        "resourceType",
        "id"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Person"
            ]
        },
        "id":{
            "type":"string"
        },
        "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/Identifier"
            }
        },
        "name":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/HumanName"
            }
        },
        "telecom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactPointForPerson"
            }
        },
        "gender":{
            "type":"string",
            "enum":[
                "male",
                "female",
                "other",
                "unknown"
            ]
        },
        "birthDate":{
            "type":"string",
            "format":"date"
        },
        "address":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Address"
            }
        },
        "active":{
            "type":"boolean"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkForPerson"
            }
        }
    }
}

Nested Schema : BundleEntrySearch

Type: object

Show Source

• mode: string

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

Nested Schema : address

Type: array

Show Source

• Array of: object Address

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

Nested Schema : identifier

Type: array

Show Source

• Array of: object Identifier

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

Nested Schema : link

Type: array

Show Source

• Array of: object LinkForPerson

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

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

Show Source

• Array of: object HumanName

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

Nested Schema : telecom

Type: array

Show Source

• Array of: object ContactPointForPerson

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

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 : 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 : Identifier

Type: object

Show Source

• period: object Period
• system: string
• type: object CodeableConcept
• use: string
• value: string

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

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 : 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"
        }
    }
}

Nested Schema : LinkForPerson

Type: object

Show Source

• target: object ReferenceForPerson

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "target":{
            "$ref":"#/components/schemas/ReferenceForPerson"
        }
    }
}

Nested Schema : ReferenceForPerson

Type: object

Show Source

• reference: string

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

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

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

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 : 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 : ContactPointForPerson

Type: object

Show Source

• extension: array extension
• period: object Period
• 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"
            ]
        },
        "value":{
            "type":"string"
        },
        "use":{
            "type":"string",
            "enum":[
                "home",
                "work",
                "temp",
                "old",
                "mobile"
            ]
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForPerson"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForPerson

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

Nested Schema : ExtensionForPerson

Type: object

Show Source

• url: string
• valueUrl: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "url":{
            "type":"string"
        },
        "valueUrl":{
            "type":"string"
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]

  The link relation.
• url: string
  The link URL.

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ],
            "description":"The link relation."
        },
        "url":{
            "type":"string",
            "description":"The link URL."
        }
    }
}

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