Skip to main content

Person

PropertyValue
Publisher
NamePerson
URLhttp://hl7.org/fhir/StructureDefinition/Person
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Person0..*PersonDemographics and administrative information about a person independent of a specific health-related context.
Person.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Person.meta0..1MetaThe 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.
Person.implicitRules0..1uriA 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.
Person.language0..1codeThe base language in which the resource is written.
Person.text0..1NarrativeA 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.
Person.contained0..*ResourceThese 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.
Person.extension0..*ExtensionMay 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.
Person.modifierExtension0..*ExtensionMay 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).
Person.identifier0..*IdentifierIdentifier for a person within a particular scope.
Person.name0..*HumanNameA name associated with the person.
Person.telecom0..*ContactPointA contact detail for the person, e.g. a telephone number or an email address.
Person.gender0..1codeAdministrative Gender.
Person.birthDate0..1dateThe birth date for the person.
Person.address0..*AddressOne or more addresses for the person.
Person.photo0..1AttachmentAn image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
Person.managingOrganization0..1ReferenceThe organization that is the custodian of the person record.
Person.active0..1booleanWhether this person's record is in active use.
Person.link0..*BackboneElementLink to a resource that concerns the same actual person.
Person.link.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Person.link.extension0..*ExtensionMay 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.
Person.link.modifierExtension0..*ExtensionMay 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).
Person.link.target1..1ReferenceThe resource to which this actual person is associated.
Person.link.assurance0..1codeLevel of assurance that this link is associated with the target resource.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
addressstringMultiple 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 textPatient.address / Person.address / Practitioner.address / RelatedPerson.address
address-citystringMultiple 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 addressPatient.address.city / Person.address.city / Practitioner.address.city / RelatedPerson.address.city
address-countrystringMultiple 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 addressPatient.address.country / Person.address.country / Practitioner.address.country / RelatedPerson.address.country
address-postalcodestringMultiple 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 addressPatient.address.postalCode / Person.address.postalCode / Practitioner.address.postalCode / RelatedPerson.address.postalCode
address-statestringMultiple 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 addressPatient.address.state / Person.address.state / Practitioner.address.state / RelatedPerson.address.state
address-usetokenMultiple 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 addressPatient.address.use / Person.address.use / Practitioner.address.use / RelatedPerson.address.use
birthdatedateMultiple Resources: * Patient: The patient's date of birth* Person: The person's date of birth* RelatedPerson: The Related Person's date of birthPatient.birthDate / Person.birthDate / RelatedPerson.birthDate
emailtokenMultiple 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 contactPatient.telecom.where(system='email') / Person.telecom.where(system='email') / Practitioner.telecom.where(system='email') / PractitionerRole.telecom.where(system='email') / RelatedPerson.telecom.where(system='email')
gendertokenMultiple Resources: * Patient: Gender of the patient* Person: The gender of the person* Practitioner: Gender of the practitioner* RelatedPerson: Gender of the related personPatient.gender / Person.gender / Practitioner.gender / RelatedPerson.gender
phonetokenMultiple 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 contactPatient.telecom.where(system='phone') / Person.telecom.where(system='phone') / Practitioner.telecom.where(system='phone') / PractitionerRole.telecom.where(system='phone') / RelatedPerson.telecom.where(system='phone')
phoneticstringMultiple 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 algorithmPatient.name / Person.name / Practitioner.name / RelatedPerson.name
telecomtokenMultiple 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 contactPatient.telecom / Person.telecom / Practitioner.telecom / PractitionerRole.telecom / RelatedPerson.telecom
identifiertokenA person IdentifierPerson.identifier
linkreferenceAny link has this Patient, Person, RelatedPerson or Practitioner referencePerson.link.target
namestringA server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or textPerson.name
organizationreferenceThe organization at which this person record is being managedPerson.managingOrganization
patientreferenceThe Person links to this PatientPerson.link.target.where(resolve() is Patient)
practitionerreferenceThe Person links to this PractitionerPerson.link.target.where(resolve() is Practitioner)
relatedpersonreferenceThe Person links to this RelatedPersonPerson.link.target.where(resolve() is RelatedPerson)