Skip to main content

Person

Trial Use 2 Base

Demographics and administrative information about a person independent of a specific health-related context.

Endpoints​

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

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*A human identifier for this person
nameHumanName0..*A name associated with the person
telecomContactPoint0..*A contact detail for the person
gendercode0..1male | female | other | unknown
birthDatedate0..1The date on which the person was born
addressAddress0..*One or more addresses for the person
photoAttachment0..1Image of the person
managingOrganizationReference0..1The organization that is the custodian of the person record
activeboolean0..1This person's record is in active use modifier
linkBackboneElement0..*Link to a resource that concerns the same actual person

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
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
emailstringhttp://hl7.org/fhir/SearchParameter/individual-email
genderstringhttp://hl7.org/fhir/SearchParameter/individual-gender
identifierstringhttp://hl7.org/fhir/SearchParameter/Person-identifier
linkstringhttp://hl7.org/fhir/SearchParameter/Person-link
namestringhttp://hl7.org/fhir/SearchParameter/Person-name
organizationstringhttp://hl7.org/fhir/SearchParameter/Person-organization
patientstringhttp://hl7.org/fhir/SearchParameter/Person-patient
phonestringhttp://hl7.org/fhir/SearchParameter/individual-phone
phoneticstringhttp://hl7.org/fhir/SearchParameter/individual-phonetic
practitionerstringhttp://hl7.org/fhir/SearchParameter/Person-practitioner
relatedpersonstringhttp://hl7.org/fhir/SearchParameter/Person-relatedperson
telecomstringhttp://hl7.org/fhir/SearchParameter/individual-telecom

Reference​

  • Official FHIR R4 spec: Person
  • Maturity: Trial Use 2 (FMM 2).