Patient | Medplum
On this page
Demographics and other administrative information about an individual or animal receiving care or other health-related services. Refer to the following profiles for information on representing specific details:
Elements
| Name | Required | Type | Description |
|---|---|---|---|
| identifier | Identifier[] | An identifier for this patient Details An identifier for this patient. |
|
| active | boolean | Whether this patient's record is in active use Details Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. |
|
| name | HumanName[] | A name associated with the patient Details A name associated with the individual. A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. |
|
| telecom | ContactPoint[] | A contact detail for the individual Details A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). |
|
| gender | code | male | female | other | unknown Details Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. |
|
| birthDate | date | The date of birth for the individual Details The date of birth for the individual. At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). |
|
| deceased[x] | boolean, dateTime | Indicates if the individual is deceased or not Details Indicates if the individual is deceased or not. If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. |
|
| address | Address[] | An address for the individual Details An address for the individual. Patient may have multiple addresses with different uses or applicable periods. |
|
| maritalStatus | CodeableConcept | Marital (civil) status of a patient Details This field contains a patient's most recent marital (civil) status. |
|
| multipleBirth[x] | boolean, integer | Whether patient is part of a multiple birth Details Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). |
|
| photo | Attachment[] | Image of the patient Details Image of the patient. Guidelines: - Use id photos, not clinical photos. - Limit dimensions to thumbnail. - Keep byte count low to ease resource updates. |
|
| contact | PatientContact[] | A contact party (e.g. guardian, partner, friend) for the patient Details A contact party (e.g. guardian, partner, friend) for the patient. Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. |
|
| id | string | Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
|
| extension | Extension[] | Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| relationship | CodeableConcept[] | The kind of relationship Details The nature of the relationship between the patient and the contact person. |
|
| name | HumanName | A name associated with the contact person Details A name associated with the contact person. |
|
| telecom | ContactPoint[] | A contact detail for the person Details A contact detail for the person, e.g. a telephone number or an email address. Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. |
|
| address | Address | Address for the contact person Details Address for the contact person. |
|
| gender | code | male | female | other | unknown Details Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. |
|
| organization | Reference< Organization > | Organization that is associated with the contact Details Organization on behalf of which the contact is acting or for which the contact is working. |
|
| period | Period | The period during which this contact person or organization is valid to be contacted relating to this patient Details The period during which this contact person or organization is valid to be contacted relating to this patient. |
|
| communication | PatientCommunication[] | A language which may be used to communicate with the patient about his or her health Details A language which may be used to communicate with the patient about his or her health. If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. |
|
| id | string | Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
|
| extension | Extension[] | Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| other | ✓ | Reference< Patient | RelatedPerson > | The other patient or related person resource that the link refers to Details The other patient resource that the link refers to. Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. |
| type | ✓ | code | replaced-by | replaces | refer | seealso Details The type of link between this patient resource and another patient resource. |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| active | token | Whether the patient record is active | Patient.active |
| address | string | 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 | Patient.address |
| address-city | string | A city specified in an address | Patient.address.city |
| address-country | string | A country specified in an address | Patient.address.country |
| address-postalcode | string | A postalCode specified in an address | Patient.address.postalCode |
| address-state | string | A state specified in an address | Patient.address.state |
| address-use | token | A use code specified in an address | Patient.address.use |
| birthdate | date | The patient's date of birth | Patient.birthDate |
| death-date | date | The date of death has been provided and satisfies this search value | Patient.deceased.ofType(dateTime) |
| deceased | token | This patient has been marked as deceased, or as a death date entered | (Patient.deceased.exists() and (Patient.deceased != false)) |
| token | A value in an email contact | Patient.telecom.where((system = 'email')) | |
| family | string | A portion of the family name of the patient | Patient.name.family |
| gender | token | Gender of the patient | Patient.gender |
| general-practitioner | reference | Patient's nominated general practitioner, not the organization that manages the record | Patient.generalPractitioner |
| given | string | A portion of the given name of the patient | Patient.name.given |
| identifier | token | A patient identifier | Patient.identifier |
| language | token | Language code (irrespective of use value) | Patient.communication.language |
| link | reference | All patients linked to the given patient | Patient.link.other |
| 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 | Patient.name |
| organization | reference | The organization that is the custodian of the patient record | Patient.managingOrganization |
| phone | token | A value in a phone contact | Patient.telecom.where((system = 'phone')) |
| phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm | Patient.name |
| telecom | token | The value in any kind of telecom details of the patient | Patient.telecom |
Inherited Elements
| Name | Required | Type | Description |
|---|---|---|---|
| id | string | Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
|
| meta | Meta | Metadata about the resource Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
|
| implicitRules | uri | A set of rules under which this content was created Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
|
| language | code | Language of the resource content Details The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
|
| text | Narrative | Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
|
| contained | Resource[] | Contained, inline Resources Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
|
| extension | Extension[] | Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| modifierExtension | Extension[] | Extensions that cannot be ignored Details May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |