Skip to main content

PagedResourcesEncounterAbridgedResource

links object[]
  • Array [
    • relstring

    Relation of this link to the current resource (for example, 'self', 'next', 'first', 'last').

    hrefstring

    Target URL.

    hreflangstring

    Language of the target resource, when applicable.

    mediastring

    Media type of the target resource, when applicable.

    titlestring

    Human-readable title of the link.

    typestring

    Content type of the target resource.

    deprecationstring

    Deprecation notice for the link, when applicable.

    profilestring

    Profile URI describing the semantics of the target resource.

    namestring

    Optional secondary identifier for the link.

  • ]
    • content object[]
  • Array [
    • encounter_idinteger<int64>
    doctor object
    namestring
    medical_license_numberstring
    specialty_namestring
    patient object
    idinteger<int64>
    given_namesstring
    surnamesstring
    full_namestring
    codestring
    ageinteger<int32>
    sexstring
    date_of_birthstring
    identity_document_typestring
    identity_document_codestring
    nationality_country_codestring
    area_codeinteger<int32>
    phone_numberstring
    email_addressstring
    enabledboolean
    manually_createdboolean
    identity_verifiedboolean
    passport_issuing_countrystring
    statusstring
    created_atstring<date-time>
    claim_idinteger<int64>
    additional_notesstring
    links object[]
  • Array [
    • relstring

    Relation of this link to the current resource (for example, 'self', 'next', 'first', 'last').

    hrefstring

    Target URL.

    hreflangstring

    Language of the target resource, when applicable.

    mediastring

    Media type of the target resource, when applicable.

    titlestring

    Human-readable title of the link.

    typestring

    Content type of the target resource.

    deprecationstring

    Deprecation notice for the link, when applicable.

    profilestring

    Profile URI describing the semantics of the target resource.

    namestring

    Optional secondary identifier for the link.

  • ]
  • ]
    • page object

    Pagination metadata returned by list endpoints.

    sizeinteger<int64>

    Number of items included in this page.

    total_elementsinteger<int64>

    Total number of items across all pages matching the query.

    total_pagesinteger<int64>

    Total number of pages available.

    numberinteger<int64>

    Current page number (0-indexed).