Skip to main content

Patient

Normative Base

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

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Patient
InteractionMethodPath
ReadGET/fhir/R4/Patient/[id]
VreadGET/fhir/R4/Patient/[id]/_history/[vid]
UpdatePUT/fhir/R4/Patient/[id]
PatchPATCH/fhir/R4/Patient/[id]
DeleteDELETE/fhir/R4/Patient/[id]
CreatePOST/fhir/R4/Patient
SearchGET/fhir/R4/Patient
HistoryGET/fhir/R4/Patient/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*An identifier for this patient
activeboolean0..1Whether this patient's record is in active use modifier
nameHumanName0..*A name associated with the patient
telecomContactPoint0..*A contact detail for the individual
gendercode0..1male | female | other | unknown
birthDatedate0..1The date of birth for the individual
deceased[x]boolean / dateTime0..1Indicates if the individual is deceased or not modifier
addressAddress0..*An address for the individual
maritalStatusCodeableConcept0..1Marital (civil) status of a patient
multipleBirth[x]boolean / integer0..1Whether patient is part of a multiple birth
photoAttachment0..*Image of the patient
contactBackboneElement0..*A contact party (e.g. guardian, partner, friend) for the patient
communicationBackboneElement0..*A language which may be used to communicate with the patient about his or her health
generalPractitionerReference0..*Patient's nominated primary care provider
managingOrganizationReference0..1Organization that is the custodian of the patient record
linkBackboneElement0..*Link to another patient resource that concerns the same actual person modifier

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
activestringhttp://hl7.org/fhir/SearchParameter/Patient-active
addressstringhttp://hl7.org/fhir/SearchParameter/individual-address
address-citystringhttp://hl7.org/fhir/SearchParameter/individual-address-city
address-countrystringhttp://hl7.org/fhir/SearchParameter/individual-address-country
address-postalcodestringhttp://hl7.org/fhir/SearchParameter/individual-address-postalcode
address-statestringhttp://hl7.org/fhir/SearchParameter/individual-address-state
address-usestringhttp://hl7.org/fhir/SearchParameter/individual-address-use
birthdatestringhttp://hl7.org/fhir/SearchParameter/individual-birthdate
death-datestringhttp://hl7.org/fhir/SearchParameter/Patient-death-date
deceasedstringhttp://hl7.org/fhir/SearchParameter/Patient-deceased
emailstringhttp://hl7.org/fhir/SearchParameter/individual-email
ethnicitystringhttp://hl7.org/fhir/us/core/SearchParameter/us-core-ethnicity
familystringhttp://hl7.org/fhir/SearchParameter/individual-family
genderstringhttp://hl7.org/fhir/SearchParameter/individual-gender
gender-identitystringhttp://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender-identity
general-practitionerstringhttp://hl7.org/fhir/SearchParameter/Patient-general-practitioner
givenstringhttp://hl7.org/fhir/SearchParameter/individual-given
identifierstringhttp://hl7.org/fhir/SearchParameter/Patient-identifier
languagestringhttp://hl7.org/fhir/SearchParameter/Patient-language
linkstringhttp://hl7.org/fhir/SearchParameter/Patient-link
namestringhttp://hl7.org/fhir/SearchParameter/Patient-name
organizationstringhttp://hl7.org/fhir/SearchParameter/Patient-organization
phonestringhttp://hl7.org/fhir/SearchParameter/individual-phone
phoneticstringhttp://hl7.org/fhir/SearchParameter/individual-phonetic
racestringhttp://hl7.org/fhir/us/core/SearchParameter/us-core-race
telecomstringhttp://hl7.org/fhir/SearchParameter/individual-telecom

Reference​

  • Official FHIR R4 spec: Patient
  • Maturity: Normative (FMM 5).