# Patient

Canonical page: https://docs.ovok.com/api/fhir/r4/patient

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Patient/[id]` |
| Vread | `GET` | `/fhir/R4/Patient/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Patient/[id]` |
| Patch | `PATCH` | `/fhir/R4/Patient/[id]` |
| Delete | `DELETE` | `/fhir/R4/Patient/[id]` |
| Create | `POST` | `/fhir/R4/Patient` |
| Search | `GET` | `/fhir/R4/Patient` |
| History | `GET` | `/fhir/R4/Patient/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | An identifier for this patient |
| <span id="element-active"></span>`active` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | Whether this patient's record is in active use |
| <span id="element-name"></span>`name` | [HumanName](/fhir-elements/complex/human-name) | `0..*` | A name associated with the patient |
| <span id="element-telecom"></span>`telecom` | [ContactPoint](/fhir-elements/complex/contact-point) | `0..*` | A contact detail for the individual |
| <span id="element-gender"></span>`gender` | [code](/fhir-elements/primitive/code) | `0..1` | male \| female \| other \| unknown |
| <span id="element-birth-date"></span>`birthDate` | [date](/fhir-elements/primitive/date) | `0..1` | The date of birth for the individual |
| <span id="element-deceased-x"></span>`deceased[x]` | [boolean](/fhir-elements/primitive/boolean), [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Indicates if the individual is deceased or not |
| <span id="element-address"></span>`address` | [Address](/fhir-elements/complex/address) | `0..*` | An address for the individual |
| <span id="element-marital-status"></span>`maritalStatus` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Marital (civil) status of a patient |
| <span id="element-multiple-birth-x"></span>`multipleBirth[x]` | [boolean](/fhir-elements/primitive/boolean), [integer](/fhir-elements/primitive/integer) | `0..1` | Whether patient is part of a multiple birth |
| <span id="element-photo"></span>`photo` | [Attachment](/fhir-elements/complex/attachment) | `0..*` | Image of the patient |
| <span id="element-contact"></span>`contact` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | A contact party (e.g. guardian, partner, friend) for the patient |
| <span id="element-communication"></span>`communication` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | A language which may be used to communicate with the patient about his or her health |
| <span id="element-general-practitioner"></span>`generalPractitioner` | [Reference](/fhir-elements/complex/reference) | `0..*` | Patient's nominated primary care provider |
| <span id="element-managing-organization"></span>`managingOrganization` | [Reference](/fhir-elements/complex/reference) | `0..1` | Organization that is the custodian of the patient record |
| <span id="element-link"></span>`link` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Link to another patient resource that concerns the same actual person |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `active` | token | Whether the patient record is active |
| `address` | string | Multiple Resources: Patient: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text ; Person: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text ; Practitioner: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text ; RelatedPerson: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text  |
| `address-city` | string | Multiple Resources: Patient: A city specified in an address ; Person: A city specified in an address ; Practitioner: A city specified in an address ; RelatedPerson: A city specified in an address  |
| `address-country` | string | Multiple Resources: Patient: A country specified in an address ; Person: A country specified in an address ; Practitioner: A country specified in an address ; RelatedPerson: A country specified in an address  |
| `address-postalcode` | string | Multiple Resources: Patient: A postalCode specified in an address ; Person: A postal code specified in an address ; Practitioner: A postalCode specified in an address ; RelatedPerson: A postal code specified in an address  |
| `address-state` | string | Multiple Resources: Patient: A state specified in an address ; Person: A state specified in an address ; Practitioner: A state specified in an address ; RelatedPerson: A state specified in an address  |
| `address-use` | token | Multiple Resources: Patient: A use code specified in an address ; Person: A use code specified in an address ; Practitioner: A use code specified in an address ; RelatedPerson: A use code specified in an address  |
| `age` | number | Searches for patients based on age as calculated based on current date and date of birth.  Deceased patients are excluded from the search. |
| `birthdate` | date | Multiple Resources: Patient: The patient's date of birth ; Person: The person's date of birth ; RelatedPerson: The Related Person's date of birth  |
| `birthOrderBoolean` | token | Search based on whether a patient was part of a multiple birth or not. |
| `death-date` | date | The date of death has been provided and satisfies this search value |
| `deceased` | token | This patient has been marked as deceased, or as a death date entered |
| `email` | token | Multiple Resources: Patient: A value in an email contact ; Person: A value in an email contact ; Practitioner: A value in an email contact ; PractitionerRole: A value in an email contact ; RelatedPerson: A value in an email contact  |
| `family` | string | Multiple Resources: Patient: A portion of the family name of the patient ; Practitioner: A portion of the family name  |
| `gender` | token | Multiple Resources: Patient: Gender of the patient ; Person: The gender of the person ; Practitioner: Gender of the practitioner ; RelatedPerson: Gender of the related person  |
| `general-practitioner` | reference | Patient's nominated general practitioner, not the organization that manages the record |
| `given` | string | Multiple Resources: Patient: A portion of the given name of the patient ; Practitioner: A portion of the given name  |
| `identifier` | token | A patient identifier |
| `language` | token | Language code (irrespective of use value) |
| `link` | reference | All patients linked to the given patient |
| `mothersMaidenName` | string | Search based on patient's mother's maiden name |
| `name` | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| `organization` | reference | The organization that is the custodian of the patient record |
| `part-agree` | reference | Search by url for a participation agreement, which is stored in a DocumentReference |
| `phone` | token | Multiple Resources: Patient: A value in a phone contact ; Person: A value in a phone contact ; Practitioner: A value in a phone contact ; PractitionerRole: A value in a phone contact ; RelatedPerson: A value in a phone contact  |
| `phonetic` | string | Multiple Resources: Patient: A portion of either family or given name using some kind of phonetic matching algorithm ; Person: A portion of name using some kind of phonetic matching algorithm ; Practitioner: A portion of either family or given name using some kind of phonetic matching algorithm ; RelatedPerson: A portion of name using some kind of phonetic matching algorithm  |
| `telecom` | token | Multiple Resources: Patient: The value in any kind of telecom details of the patient ; Person: The value in any kind of contact ; Practitioner: The value in any kind of contact ; PractitionerRole: The value in any kind of contact ; RelatedPerson: The value in any kind of contact  |

## Reference [#reference]

Official FHIR R4 spec: [Patient](https://hl7.org/fhir/R4/patient.html).  
Maturity: Trial Use 5 (FMM 5).
