Skip to main content
Read Patient
curl --request GET \
  --url https://{tenant_id}.api.nestmed.com/fhir/r4/Patient/{id} \
  --header 'Authorization: Bearer <token>'
{
  "resourceType": "Patient",
  "id": "<string>",
  "meta": {
    "versionId": "<string>",
    "lastUpdated": "2023-11-07T05:31:56Z",
    "source": "<string>",
    "profile": [
      "<string>"
    ],
    "security": [
      {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      }
    ],
    "tag": [
      {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      }
    ]
  },
  "implicitRules": "<string>",
  "language": "<string>",
  "text": {
    "status": "generated",
    "div": "<string>"
  },
  "contained": [
    {}
  ],
  "extension": [
    {
      "url": "<string>",
      "valueBoolean": true,
      "valueInteger": 123,
      "valueDecimal": 123,
      "valueString": "<string>",
      "valueUri": "<string>",
      "valueDate": "2023-12-25",
      "valueDateTime": "2023-11-07T05:31:56Z",
      "valueCode": "<string>",
      "valueCoding": {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "valueQuantity": {
        "value": 123,
        "comparator": "<",
        "unit": "<string>",
        "system": "<string>",
        "code": "<string>"
      },
      "valuePeriod": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "valueReference": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      },
      "valueAttachment": {
        "contentType": "<string>",
        "language": "<string>",
        "data": "aSDinaTvuI8gbWludGxpZnk=",
        "url": "<string>",
        "size": 123,
        "hash": "<string>",
        "title": "<string>",
        "creation": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "modifierExtension": [
    {
      "url": "<string>",
      "valueBoolean": true,
      "valueInteger": 123,
      "valueDecimal": 123,
      "valueString": "<string>",
      "valueUri": "<string>",
      "valueDate": "2023-12-25",
      "valueDateTime": "2023-11-07T05:31:56Z",
      "valueCode": "<string>",
      "valueCoding": {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "valueQuantity": {
        "value": 123,
        "comparator": "<",
        "unit": "<string>",
        "system": "<string>",
        "code": "<string>"
      },
      "valuePeriod": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "valueReference": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      },
      "valueAttachment": {
        "contentType": "<string>",
        "language": "<string>",
        "data": "aSDinaTvuI8gbWludGxpZnk=",
        "url": "<string>",
        "size": 123,
        "hash": "<string>",
        "title": "<string>",
        "creation": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "identifier": [
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    }
  ],
  "active": true,
  "name": [
    {
      "use": "usual",
      "text": "<string>",
      "family": "<string>",
      "given": [
        "<string>"
      ],
      "prefix": [
        "<string>"
      ],
      "suffix": [
        "<string>"
      ],
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "<string>",
      "use": "home",
      "rank": 123,
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "gender": "male",
  "birthDate": "2023-12-25",
  "deceasedBoolean": true,
  "deceasedDateTime": "2023-11-07T05:31:56Z",
  "address": [
    {
      "use": "home",
      "type": "postal",
      "text": "<string>",
      "line": [
        "<string>"
      ],
      "city": "<string>",
      "district": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "maritalStatus": {
    "coding": [
      {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      }
    ],
    "text": "<string>"
  },
  "multipleBirthBoolean": true,
  "multipleBirthInteger": 123,
  "contact": [
    {
      "relationship": [
        {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        }
      ],
      "name": {
        "use": "usual",
        "text": "<string>",
        "family": "<string>",
        "given": [
          "<string>"
        ],
        "prefix": [
          "<string>"
        ],
        "suffix": [
          "<string>"
        ],
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        }
      },
      "telecom": [
        {
          "system": "phone",
          "value": "<string>",
          "use": "home",
          "rank": 123,
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "address": {
        "use": "home",
        "type": "postal",
        "text": "<string>",
        "line": [
          "<string>"
        ],
        "city": "<string>",
        "district": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        }
      },
      "gender": "<string>",
      "organization": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      },
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "preferred": true
    }
  ],
  "generalPractitioner": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "managingOrganization": {
    "reference": "<string>",
    "type": "<string>",
    "identifier": {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    },
    "display": "<string>"
  },
  "link": [
    {
      "other": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      },
      "type": "replaced-by"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required

Logical id of the patient

Query Parameters

_format
enum<string>

Response format

Available options:
json,
xml,
application/fhir+json,
application/fhir+xml

Response

Patient resource

resourceType
enum<string>
required
Available options:
Patient
id
string
meta
object
implicitRules
string<uri>
language
string
text
object
contained
object[]
extension
object[]
modifierExtension
object[]
identifier
object[]
active
boolean
name
object[]
telecom
object[]
gender
enum<string>
Available options:
male,
female,
other,
unknown
birthDate
string<date>
deceasedBoolean
boolean
deceasedDateTime
string<date-time>
address
object[]
maritalStatus
object
multipleBirthBoolean
boolean
multipleBirthInteger
integer
contact
object[]
communication
object[]
generalPractitioner
object[]
managingOrganization
object