FHIR Release 3 (STU) Current Build

8.1 Resource Patient - Content

Patient Administration Work Group Maturity Level : 5 N   Trial Use Normative (from v4.0.0) Security Category : Patient Compartments : Patient , Practitioner , RelatedPerson

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

This Resource covers data about patients and animals involved in a wide range of health-related activities, including:

  • Curative activities
  • Psychiatric care
  • Social services
  • Pregnancy care
  • Nursing and assisted living
  • Dietary services
  • Tracking of personal health and exercise data

The data in the Resource covers the "who" information about the patient: its attributes are focused on the demographic information necessary to support the administrative, financial and logistic procedures. A Patient record is generally created and maintained by each organization providing care for a patient. A patient or animal receiving care at multiple organizations may therefore have its information present in multiple Patient Resources.

Not all concepts are included within the base resource (such as race, ethnicity, organ donor status, nationalilty, nationality, etc.), but may be found in profiles defined for specific jurisdictions (e.g., US Meaningful Use Program) or standard extensions . Such fields vary widely between jurisdictions and often have different names and valuesets for the similar concepts, but they are not similar enough to be able to map and exchange exchange.

This resource is referenced by Annotation , Signature , Account , AdverseEvent , AllergyIntolerance , Appointment , AppointmentResponse , AuditEvent , Basic , BodySite BiologicallyDerivedProduct , BodyStructure , CarePlan , CareTeam , ChargeItem , Claim , ClaimResponse , ClinicalImpression , Communication , CommunicationRequest , Composition , Condition , Consent , Contract , Coverage , CoverageEligibilityRequest , CoverageEligibilityResponse , DetectedIssue , Device , DeviceRequest , DeviceUseStatement , DiagnosticReport , DocumentManifest , DocumentReference , EligibilityRequest , Encounter , EnrollmentRequest , EpisodeOfCare , ExplanationOfBenefit , FamilyMemberHistory , Flag , Goal , Group , GuidanceResponse , ImagingManifest , ImagingStudy , Immunization , ImmunizationEvaluation , ImmunizationRecommendation , Invoice , List , MeasureReport , Media , MedicationAdministration , MedicationDispense , MedicationRequest , MedicationStatement , MolecularSequence , NutritionOrder , Observation , itself, Person , Procedure , ProcedureRequest , Provenance , QuestionnaireResponse , ReferralRequest , RelatedPerson , RequestGroup , ResearchSubject , RiskAssessment , Schedule , Sequence ServiceRequest , Specimen , SupplyDelivery , SupplyRequest , Task and VisionPrescription

Structure

Name Flags Card. Type Description & Constraints doco
. . Patient N DomainResource Information about an individual or animal receiving health care services
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier An identifier for this patient
. . . active ?! Σ 0..1 boolean Whether this patient's record is in active use
. . . name Σ 0..* HumanName A name associated with the patient
. . . telecom Σ 0..* ContactPoint A contact detail for the individual
. . . gender Σ 0..1 code male | female | other | unknown
AdministrativeGender ( Required )
. . . birthDate Σ 0..1 date The date of birth for the individual
. . . deceased[x] ?! Σ 0..1 Indicates if the individual is deceased or not
. . . . deceasedBoolean boolean
. . . . deceasedDateTime dateTime
. . . address Σ 0..* Address Addresses An address for the individual
. . . maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Marital Status Codes MaritalStatus ( Extensible )
. . . multipleBirth[x] 0..1 Whether patient is part of a multiple birth
. . . . multipleBirthBoolean boolean
. . . . multipleBirthInteger integer
. . . photo 0..* Attachment Image of the patient
. . . contact I 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
+ Rule: SHALL at least contain a contact's details or a reference to an organization
. . . . relationship 0..* CodeableConcept The kind of relationship
v2 Patient Contact Role Relationship ( Extensible )
. . . . name 0..1 HumanName A name associated with the contact person
. . . . telecom 0..* ContactPoint A contact detail for the person
. . . . address 0..1 Address Address for the contact person
. . . . gender 0..1 code male | female | other | unknown
AdministrativeGender ( Required )
. . . . organization I 0..1 Reference ( Organization ) Organization that is associated with the contact
. . . . period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
. . . animal ?! Σ 0..1 BackboneElement This patient is known to be an animal (non-human) species Σ 1..1 CodeableConcept E.g. Dog, Cow AnimalSpecies ( Example ) breed Σ 0..1 CodeableConcept E.g. Poodle, Angus AnimalBreeds ( Example ) genderStatus Σ 0..1 CodeableConcept E.g. Neutered, Intact GenderStatus ( Example ) communication 0..* BackboneElement A list of Languages language which may be used to communicate with the patient about his or her health
. . . . language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Common Languages ( Extensible Preferred but limited to All Languages AllLanguages )
. . . . preferred 0..1 boolean Language preference indicator
. . . generalPractitioner 0..* Reference ( Organization | Practitioner | PractitionerRole ) Patient's nominated primary care provider
. . . managingOrganization Σ 0..1 Reference ( Organization ) Organization that is the custodian of the patient record
. . . link ?! Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
. . . . other Σ 1..1 Reference ( Patient | RelatedPerson ) The other patient or related person resource that the link refers to
. . . . type Σ 1..1 code replaced-by | replaces | refer | seealso - type of link
LinkType ( Required )

doco Documentation for this format

UML Diagram ( Legend )

Patient ( DomainResource ) An identifier for this patient identifier : Identifier [0..*] 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 (this element modifies the meaning of other elements) active : boolean [0..1] A name associated with the individual name : HumanName [0..*] A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted telecom : ContactPoint [0..*] Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes gender : code [0..1] « The gender of a person used for administrative purposes. (Strength=Required) AdministrativeGender ! » The date of birth for the individual birthDate : date [0..1] Indicates if the individual is deceased or not (this element modifies the meaning of other elements) deceased[x] : Type [0..1] « boolean | dateTime » Addresses An address for the individual address : Address [0..*] This field contains a patient's most recent marital (civil) status maritalStatus : CodeableConcept [0..1] « The domestic partnership status of a person. (Strength=Extensible) Marital Status + » Indicates whether the patient is part of a multiple (bool) (boolean) or indicates the actual birth order (integer) multipleBirth[x] : Type [0..1] « boolean | integer » Image of the patient photo : Attachment [0..*] Patient's nominated care provider generalPractitioner : Reference [0..*] « Organization | Practitioner | PractitionerRole » Organization that is the custodian of the patient record managingOrganization : Reference [0..1] « Organization » Contact The nature of the relationship between the patient and the contact person relationship : CodeableConcept [0..*] « The nature of the relationship between a patient and a contact person for that patient. (Strength=Extensible) v2 Contact Role PatientContactRelationship + » A name associated with the contact person name : HumanName [0..1] A contact detail for the person, e.g. a telephone number or an email address telecom : ContactPoint [0..*] Address for the contact person address : Address [0..1] Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes gender : code [0..1] « The gender of a person used for administrative purposes. (Strength=Required) AdministrativeGender ! » Organization on behalf of which the contact is acting or for which the contact is working organization : Reference [0..1] « Organization » The period during which this contact person or organization is valid to be contacted relating to this patient period : Period [0..1] Animal Identifies the high level taxonomic categorization of the kind of animal species : CodeableConcept [1..1] The species of an animal. (Strength=Example) AnimalSpecies ?? Identifies the detailed categorization of the kind of animal breed : CodeableConcept [0..1] The breed of an animal. (Strength=Example) AnimalBreeds ?? Indicates the current state of the animal's reproductive organs genderStatus : CodeableConcept [0..1] The state of the animal's reproductive organs. (Strength=Example) GenderStatus ?? Communication The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English language : CodeableConcept [1..1] « A human language. (Strength=Extensible) (Strength=Preferred) Common Languages CommonLanguages + ? » Indicates whether or not the patient prefers this language (over other languages he masters up a certain level) preferred : boolean [0..1] Link The other patient resource that the link refers to other : Reference [1..1] « Patient | RelatedPerson » The type of link between this patient resource and another patient resource type : code [1..1] « The type of link between this patient resource and another patient resource. (Strength=Required) LinkType ! » A contact party (e.g. guardian, partner, friend) for the patient contact [0..*] This patient is known to be an animal (this element modifies the meaning of other elements) animal [0..1] Languages A language which may be used to communicate with the patient about his or her health communication [0..*] Link to another patient resource that concerns the same actual patient (this element modifies the meaning of other elements) link [0..*]

XML Template

<Patient xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier An identifier for this patient --></identifier>
 <

 <active value="[boolean]"/><!-- 0..1 Whether this patient's record is in active use -->

 <name><!-- 0..* HumanName A name associated with the patient --></name>
 <telecom><!-- 0..* ContactPoint A contact detail for the individual --></telecom>
 <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
 <birthDate value="[date]"/><!-- 0..1 The date of birth for the individual -->
 <deceased[x]><!-- 0..1 boolean|dateTime Indicates if the individual is deceased or not --></deceased[x]>
 <</address>

 <address><!-- 0..* Address An address for the individual --></address>

 <maritalStatus><!-- 0..1 CodeableConcept Marital (civil) status of a patient --></maritalStatus>
 <</multipleBirth[x]>

 <multipleBirth[x]><!-- 0..1 boolean|integer Whether patient is part of a multiple birth --></multipleBirth[x]>

 <photo><!-- 0..* Attachment Image of the patient --></photo>
 <contact>  <!-- 0..* A contact party (e.g. guardian, partner, friend) for the patient -->
  <</relationship>

  <relationship><!-- 0..* CodeableConcept The kind of relationship --></relationship>

  <name><!-- 0..1 HumanName A name associated with the contact person --></name>
  <telecom><!-- 0..* ContactPoint A contact detail for the person --></telecom>
  <address><!-- 0..1 Address Address for the contact person --></address>
  <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
  <organization><!-- ?? 0..1 Reference(Organization) Organization that is associated with the contact --></organization>
  <period><!-- 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient --></period>
 </contact>
 <
  <</species>
  <</breed>
  <</genderStatus>
 </animal>
 <

 <communication>  <!-- 0..* A language which may be used to communicate with the patient about his or her health -->

  <language><!-- 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health --></language>
  <preferred value="[boolean]"/><!-- 0..1 Language preference indicator -->
 </communication>
 <</generalPractitioner>

 <generalPractitioner><!-- 0..* Reference(Organization|Practitioner|
   PractitionerRole) Patient's nominated primary care provider --></generalPractitioner>
 <managingOrganization><!-- 0..1 Reference(Organization) Organization that is the custodian of the patient record --></managingOrganization>
 <link>  <!-- 0..* Link to another patient resource that concerns the same actual person -->
  <other><!-- 1..1 Reference(Patient|RelatedPerson) The other patient or related person resource that the link refers to --></other>
  <

  <type value="[code]"/><!-- 1..1 replaced-by | replaces | refer | seealso -->

 </link>
</Patient>

JSON Template

{doco
  "resourceType" : "Patient",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // An identifier for this patient
  "

  "active" : <boolean>, // Whether this patient's record is in active use

  "name" : [{ HumanName }], // A name associated with the patient
  "telecom" : [{ ContactPoint }], // A contact detail for the individual
  "gender" : "<code>", // male | female | other | unknown
  "birthDate" : "<date>", // The date of birth for the individual
  // deceased[x]: Indicates if the individual is deceased or not. One of these 2:
  "deceasedBoolean" : <boolean>,
  "deceasedDateTime" : "<dateTime>",
  "

  "address" : [{ Address }], // An address for the individual

  "maritalStatus" : { CodeableConcept }, // Marital (civil) status of a patient
  // multipleBirth[x]: Whether patient is part of a multiple birth. One of these 2:
  ">,
  ">,

  "multipleBirthBoolean" : <boolean>,
  "multipleBirthInteger" : <integer>,

  "photo" : [{ Attachment }], // Image of the patient
  "contact" : [{ // A contact party (e.g. guardian, partner, friend) for the patient
    "

    "relationship" : [{ CodeableConcept }], // The kind of relationship

    "name" : { HumanName }, // A name associated with the contact person
    "telecom" : [{ ContactPoint }], // A contact detail for the person
    "address" : { Address }, // Address for the contact person
    "gender" : "<code>", // male | female | other | unknown
    "organization" : { Reference(Organization) }, // C? Organization that is associated with the contact
    "period" : { Period } // The period during which this contact person or organization is valid to be contacted relating to this patient
  }],
  "
    "
    "
    "
  },
  "

  "communication" : [{ // A language which may be used to communicate with the patient about his or her health

    "language" : { CodeableConcept }, // R!  The language which can be used to communicate with the patient about his or her health
    "preferred" : <boolean> // Language preference indicator
  }],
  "

  "generalPractitioner" : [{ Reference(Organization|Practitioner|
   PractitionerRole) }], // Patient's nominated primary care provider
  "managingOrganization" : { Reference(Organization) }, // Organization that is the custodian of the patient record
  "link" : [{ // Link to another patient resource that concerns the same actual person
    "other" : { Reference(Patient|RelatedPerson) }, // R!  The other patient or related person resource that the link refers to
    "

    "type" : "<code>" // R!  replaced-by | replaces | refer | seealso

  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:Patient;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Patient.identifier [ Identifier ], ... ; # 0..* An identifier for this patient
  fhir:

  fhir:Patient.active [ boolean ]; # 0..1 Whether this patient's record is in active use

  fhir:Patient.name [ HumanName ], ... ; # 0..* A name associated with the patient
  fhir:Patient.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the individual
  fhir:Patient.gender [ code ]; # 0..1 male | female | other | unknown
  fhir:Patient.birthDate [ date ]; # 0..1 The date of birth for the individual
  # Patient.deceased[x] : 0..1 Indicates if the individual is deceased or not. One of these 2
    fhir:Patient.deceasedBoolean [ boolean ]
    fhir:Patient.deceasedDateTime [ dateTime ]
  fhir:

  fhir:Patient.address [ Address ], ... ; # 0..* An address for the individual

  fhir:Patient.maritalStatus [ CodeableConcept ]; # 0..1 Marital (civil) status of a patient
  # . One of these 2
    fhir: ]
    fhir: ]

  # Patient.multipleBirth[x] : 0..1 Whether patient is part of a multiple birth. One of these 2
    fhir:Patient.multipleBirthBoolean [ boolean ]
    fhir:Patient.multipleBirthInteger [ integer ]

  fhir:Patient.photo [ Attachment ], ... ; # 0..* Image of the patient
  fhir:Patient.contact [ # 0..* A contact party (e.g. guardian, partner, friend) for the patient
    fhir:Patient.contact.relationship [ CodeableConcept ], ... ; # 0..* The kind of relationship
    fhir:Patient.contact.name [ HumanName ]; # 0..1 A name associated with the contact person
    fhir:Patient.contact.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the person
    fhir:Patient.contact.address [ Address ]; # 0..1 Address for the contact person
    fhir:Patient.contact.gender [ code ]; # 0..1 male | female | other | unknown
    fhir:Patient.contact.organization [ Reference(Organization) ]; # 0..1 Organization that is associated with the contact
    fhir:Patient.contact.period [ Period ]; # 0..1 The period during which this contact person or organization is valid to be contacted relating to this patient
  ], ...;
  fhir:
    fhir:
    fhir:
    fhir:
  ];
  fhir:

  fhir:Patient.communication [ # 0..* A language which may be used to communicate with the patient about his or her health

    fhir:Patient.communication.language [ CodeableConcept ]; # 1..1 The language which can be used to communicate with the patient about his or her health
    fhir:Patient.communication.preferred [ boolean ]; # 0..1 Language preference indicator
  ], ...;
  fhir:

  fhir:Patient.generalPractitioner [ Reference(Organization|Practitioner|PractitionerRole) ], ... ; # 0..* Patient's nominated primary care provider

  fhir:Patient.managingOrganization [ Reference(Organization) ]; # 0..1 Organization that is the custodian of the patient record
  fhir:Patient.link [ # 0..* Link to another patient resource that concerns the same actual person
    fhir:Patient.link.other [ Reference(Patient|RelatedPerson) ]; # 1..1 The other patient or related person resource that the link refers to
    fhir:

    fhir:Patient.link.type [ code ]; # 1..1 replaced-by | replaces | refer | seealso

  ], ...;
]

Changes since DSTU2 R3

Patient
Patient.maritalStatus Patient.active
  • Change binding strength from required to extensible Default Value "true" removed
Patient.contact.relationship Patient.gender
  • Change value set from http://hl7.org/fhir/ValueSet/patient-contact-relationship http://hl7.org/fhir/ValueSet/administrative-gender to http://hl7.org/fhir/ValueSet/v2-0131 http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0
Patient.communication.language Patient.contact.relationship
  • Change binding strength value set from required http://terminology.hl7.org/ValueSet/v2-0131 to extensible http://hl7.org/fhir/ValueSet/patient-contactrelationship
Patient.contact.gender
  • Change value set from http://tools.ietf.org/html/bcp47 http://hl7.org/fhir/ValueSet/administrative-gender to http://hl7.org/fhir/ValueSet/languages http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0
Patient.generalPractitioner Patient.communication.language
  • Renamed Change binding strength from careProvider extensible to generalPractitioner preferred
Patient.link.other Patient.generalPractitioner
  • Add Reference(RelatedPerson) No longer marked as Modifier Type Reference: Added Target Type PractitionerRole
Patient.link.type
  • No longer marked as Modifier Change value set from http://hl7.org/fhir/ValueSet/link-type to http://hl7.org/fhir/ValueSet/link-type|4.0.0
Patient.animal
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 18 16 tests that all execute ok. All tests pass round-trip testing and 6 all r3 resources are invalid (12 errors). ). valid.)

Structure

Name Flags Card. Type Description & Constraints doco
. . Patient N DomainResource Information about an individual or animal receiving health care services
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier An identifier for this patient
. . . active ?! Σ 0..1 boolean Whether this patient's record is in active use
. . . name Σ 0..* HumanName A name associated with the patient
. . . telecom Σ 0..* ContactPoint A contact detail for the individual
. . . gender Σ 0..1 code male | female | other | unknown
AdministrativeGender ( Required )
. . . birthDate Σ 0..1 date The date of birth for the individual
. . . deceased[x] ?! Σ 0..1 Indicates if the individual is deceased or not
. . . . deceasedBoolean boolean
. . . . deceasedDateTime dateTime
. . . address Σ 0..* Address Addresses An address for the individual
. . . maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Marital Status Codes MaritalStatus ( Extensible )
. . . multipleBirth[x] 0..1 Whether patient is part of a multiple birth
. . . . multipleBirthBoolean boolean
. . . . multipleBirthInteger integer
. . . photo 0..* Attachment Image of the patient
. . . contact I 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
+ Rule: SHALL at least contain a contact's details or a reference to an organization
. . . . relationship 0..* CodeableConcept The kind of relationship
v2 Patient Contact Role Relationship ( Extensible )
. . . . name 0..1 HumanName A name associated with the contact person
. . . . telecom 0..* ContactPoint A contact detail for the person
. . . . address 0..1 Address Address for the contact person
. . . . gender 0..1 code male | female | other | unknown
AdministrativeGender ( Required )
. . . . organization I 0..1 Reference ( Organization ) Organization that is associated with the contact
. . . . period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
. . . animal ?! Σ 0..1 BackboneElement This patient is known to be an animal (non-human) species Σ 1..1 CodeableConcept E.g. Dog, Cow AnimalSpecies ( Example ) breed Σ 0..1 CodeableConcept E.g. Poodle, Angus AnimalBreeds ( Example ) genderStatus Σ 0..1 CodeableConcept E.g. Neutered, Intact GenderStatus ( Example ) communication 0..* BackboneElement A list of Languages language which may be used to communicate with the patient about his or her health
. . . . language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Common Languages ( Extensible Preferred but limited to All Languages AllLanguages )
. . . . preferred 0..1 boolean Language preference indicator
. . . generalPractitioner 0..* Reference ( Organization | Practitioner | PractitionerRole ) Patient's nominated primary care provider
. . . managingOrganization Σ 0..1 Reference ( Organization ) Organization that is the custodian of the patient record
. . . link ?! Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
. . . . other Σ 1..1 Reference ( Patient | RelatedPerson ) The other patient or related person resource that the link refers to
. . . . type Σ 1..1 code replaced-by | replaces | refer | seealso - type of link
LinkType ( Required )

doco Documentation for this format

UML Diagram ( Legend )

Patient ( DomainResource ) An identifier for this patient identifier : Identifier [0..*] 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 (this element modifies the meaning of other elements) active : boolean [0..1] A name associated with the individual name : HumanName [0..*] A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted telecom : ContactPoint [0..*] Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes gender : code [0..1] « The gender of a person used for administrative purposes. (Strength=Required) AdministrativeGender ! » The date of birth for the individual birthDate : date [0..1] Indicates if the individual is deceased or not (this element modifies the meaning of other elements) deceased[x] : Type [0..1] « boolean | dateTime » Addresses An address for the individual address : Address [0..*] This field contains a patient's most recent marital (civil) status maritalStatus : CodeableConcept [0..1] « The domestic partnership status of a person. (Strength=Extensible) Marital Status + » Indicates whether the patient is part of a multiple (bool) (boolean) or indicates the actual birth order (integer) multipleBirth[x] : Type [0..1] « boolean | integer » Image of the patient photo : Attachment [0..*] Patient's nominated care provider generalPractitioner : Reference [0..*] « Organization | Practitioner | PractitionerRole » Organization that is the custodian of the patient record managingOrganization : Reference [0..1] « Organization » Contact The nature of the relationship between the patient and the contact person relationship : CodeableConcept [0..*] « The nature of the relationship between a patient and a contact person for that patient. (Strength=Extensible) v2 Contact Role PatientContactRelationship + » A name associated with the contact person name : HumanName [0..1] A contact detail for the person, e.g. a telephone number or an email address telecom : ContactPoint [0..*] Address for the contact person address : Address [0..1] Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes gender : code [0..1] « The gender of a person used for administrative purposes. (Strength=Required) AdministrativeGender ! » Organization on behalf of which the contact is acting or for which the contact is working organization : Reference [0..1] « Organization » The period during which this contact person or organization is valid to be contacted relating to this patient period : Period [0..1] Animal Identifies the high level taxonomic categorization of the kind of animal species : CodeableConcept [1..1] The species of an animal. (Strength=Example) AnimalSpecies ?? Identifies the detailed categorization of the kind of animal breed : CodeableConcept [0..1] The breed of an animal. (Strength=Example) AnimalBreeds ?? Indicates the current state of the animal's reproductive organs genderStatus : CodeableConcept [0..1] The state of the animal's reproductive organs. (Strength=Example) GenderStatus ?? Communication The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English language : CodeableConcept [1..1] « A human language. (Strength=Extensible) (Strength=Preferred) Common Languages CommonLanguages + ? » Indicates whether or not the patient prefers this language (over other languages he masters up a certain level) preferred : boolean [0..1] Link The other patient resource that the link refers to other : Reference [1..1] « Patient | RelatedPerson » The type of link between this patient resource and another patient resource type : code [1..1] « The type of link between this patient resource and another patient resource. (Strength=Required) LinkType ! » A contact party (e.g. guardian, partner, friend) for the patient contact [0..*] This patient is known to be an animal (this element modifies the meaning of other elements) animal [0..1] Languages A language which may be used to communicate with the patient about his or her health communication [0..*] Link to another patient resource that concerns the same actual patient (this element modifies the meaning of other elements) link [0..*]

XML Template

<Patient xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier An identifier for this patient --></identifier>
 <

 <active value="[boolean]"/><!-- 0..1 Whether this patient's record is in active use -->

 <name><!-- 0..* HumanName A name associated with the patient --></name>
 <telecom><!-- 0..* ContactPoint A contact detail for the individual --></telecom>
 <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
 <birthDate value="[date]"/><!-- 0..1 The date of birth for the individual -->
 <deceased[x]><!-- 0..1 boolean|dateTime Indicates if the individual is deceased or not --></deceased[x]>
 <</address>

 <address><!-- 0..* Address An address for the individual --></address>

 <maritalStatus><!-- 0..1 CodeableConcept Marital (civil) status of a patient --></maritalStatus>
 <</multipleBirth[x]>

 <multipleBirth[x]><!-- 0..1 boolean|integer Whether patient is part of a multiple birth --></multipleBirth[x]>

 <photo><!-- 0..* Attachment Image of the patient --></photo>
 <contact>  <!-- 0..* A contact party (e.g. guardian, partner, friend) for the patient -->
  <</relationship>

  <relationship><!-- 0..* CodeableConcept The kind of relationship --></relationship>

  <name><!-- 0..1 HumanName A name associated with the contact person --></name>
  <telecom><!-- 0..* ContactPoint A contact detail for the person --></telecom>
  <address><!-- 0..1 Address Address for the contact person --></address>
  <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
  <organization><!-- ?? 0..1 Reference(Organization) Organization that is associated with the contact --></organization>
  <period><!-- 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient --></period>
 </contact>
 <
  <</species>
  <</breed>
  <</genderStatus>
 </animal>
 <

 <communication>  <!-- 0..* A language which may be used to communicate with the patient about his or her health -->

  <language><!-- 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health --></language>
  <preferred value="[boolean]"/><!-- 0..1 Language preference indicator -->
 </communication>
 <</generalPractitioner>

 <generalPractitioner><!-- 0..* Reference(Organization|Practitioner|
   PractitionerRole) Patient's nominated primary care provider --></generalPractitioner>
 <managingOrganization><!-- 0..1 Reference(Organization) Organization that is the custodian of the patient record --></managingOrganization>
 <link>  <!-- 0..* Link to another patient resource that concerns the same actual person -->
  <other><!-- 1..1 Reference(Patient|RelatedPerson) The other patient or related person resource that the link refers to --></other>
  <

  <type value="[code]"/><!-- 1..1 replaced-by | replaces | refer | seealso -->

 </link>
</Patient>

JSON Template

{doco
  "resourceType" : "Patient",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // An identifier for this patient
  "

  "active" : <boolean>, // Whether this patient's record is in active use

  "name" : [{ HumanName }], // A name associated with the patient
  "telecom" : [{ ContactPoint }], // A contact detail for the individual
  "gender" : "<code>", // male | female | other | unknown
  "birthDate" : "<date>", // The date of birth for the individual
  // deceased[x]: Indicates if the individual is deceased or not. One of these 2:
  "deceasedBoolean" : <boolean>,
  "deceasedDateTime" : "<dateTime>",
  "

  "address" : [{ Address }], // An address for the individual

  "maritalStatus" : { CodeableConcept }, // Marital (civil) status of a patient
  // multipleBirth[x]: Whether patient is part of a multiple birth. One of these 2:
  ">,
  ">,

  "multipleBirthBoolean" : <boolean>,
  "multipleBirthInteger" : <integer>,

  "photo" : [{ Attachment }], // Image of the patient
  "contact" : [{ // A contact party (e.g. guardian, partner, friend) for the patient
    "

    "relationship" : [{ CodeableConcept }], // The kind of relationship

    "name" : { HumanName }, // A name associated with the contact person
    "telecom" : [{ ContactPoint }], // A contact detail for the person
    "address" : { Address }, // Address for the contact person
    "gender" : "<code>", // male | female | other | unknown
    "organization" : { Reference(Organization) }, // C? Organization that is associated with the contact
    "period" : { Period } // The period during which this contact person or organization is valid to be contacted relating to this patient
  }],
  "
    "
    "
    "
  },
  "

  "communication" : [{ // A language which may be used to communicate with the patient about his or her health

    "language" : { CodeableConcept }, // R!  The language which can be used to communicate with the patient about his or her health
    "preferred" : <boolean> // Language preference indicator
  }],
  "

  "generalPractitioner" : [{ Reference(Organization|Practitioner|
   PractitionerRole) }], // Patient's nominated primary care provider
  "managingOrganization" : { Reference(Organization) }, // Organization that is the custodian of the patient record
  "link" : [{ // Link to another patient resource that concerns the same actual person
    "other" : { Reference(Patient|RelatedPerson) }, // R!  The other patient or related person resource that the link refers to
    "

    "type" : "<code>" // R!  replaced-by | replaces | refer | seealso

  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:Patient;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Patient.identifier [ Identifier ], ... ; # 0..* An identifier for this patient
  fhir:

  fhir:Patient.active [ boolean ]; # 0..1 Whether this patient's record is in active use

  fhir:Patient.name [ HumanName ], ... ; # 0..* A name associated with the patient
  fhir:Patient.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the individual
  fhir:Patient.gender [ code ]; # 0..1 male | female | other | unknown
  fhir:Patient.birthDate [ date ]; # 0..1 The date of birth for the individual
  # Patient.deceased[x] : 0..1 Indicates if the individual is deceased or not. One of these 2
    fhir:Patient.deceasedBoolean [ boolean ]
    fhir:Patient.deceasedDateTime [ dateTime ]
  fhir:

  fhir:Patient.address [ Address ], ... ; # 0..* An address for the individual

  fhir:Patient.maritalStatus [ CodeableConcept ]; # 0..1 Marital (civil) status of a patient
  # . One of these 2
    fhir: ]
    fhir: ]

  # Patient.multipleBirth[x] : 0..1 Whether patient is part of a multiple birth. One of these 2
    fhir:Patient.multipleBirthBoolean [ boolean ]
    fhir:Patient.multipleBirthInteger [ integer ]

  fhir:Patient.photo [ Attachment ], ... ; # 0..* Image of the patient
  fhir:Patient.contact [ # 0..* A contact party (e.g. guardian, partner, friend) for the patient
    fhir:Patient.contact.relationship [ CodeableConcept ], ... ; # 0..* The kind of relationship
    fhir:Patient.contact.name [ HumanName ]; # 0..1 A name associated with the contact person
    fhir:Patient.contact.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the person
    fhir:Patient.contact.address [ Address ]; # 0..1 Address for the contact person
    fhir:Patient.contact.gender [ code ]; # 0..1 male | female | other | unknown
    fhir:Patient.contact.organization [ Reference(Organization) ]; # 0..1 Organization that is associated with the contact
    fhir:Patient.contact.period [ Period ]; # 0..1 The period during which this contact person or organization is valid to be contacted relating to this patient
  ], ...;
  fhir:
    fhir:
    fhir:
    fhir:
  ];
  fhir:

  fhir:Patient.communication [ # 0..* A language which may be used to communicate with the patient about his or her health

    fhir:Patient.communication.language [ CodeableConcept ]; # 1..1 The language which can be used to communicate with the patient about his or her health
    fhir:Patient.communication.preferred [ boolean ]; # 0..1 Language preference indicator
  ], ...;
  fhir:

  fhir:Patient.generalPractitioner [ Reference(Organization|Practitioner|PractitionerRole) ], ... ; # 0..* Patient's nominated primary care provider

  fhir:Patient.managingOrganization [ Reference(Organization) ]; # 0..1 Organization that is the custodian of the patient record
  fhir:Patient.link [ # 0..* Link to another patient resource that concerns the same actual person
    fhir:Patient.link.other [ Reference(Patient|RelatedPerson) ]; # 1..1 The other patient or related person resource that the link refers to
    fhir:

    fhir:Patient.link.type [ code ]; # 1..1 replaced-by | replaces | refer | seealso

  ], ...;
]

Changes since DSTU2 Release 3

Patient
Patient.maritalStatus Patient.active
  • Change binding strength from required to extensible Default Value "true" removed
Patient.contact.relationship Patient.gender
  • Change value set from http://hl7.org/fhir/ValueSet/patient-contact-relationship http://hl7.org/fhir/ValueSet/administrative-gender to http://hl7.org/fhir/ValueSet/v2-0131 http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0
Patient.communication.language Patient.contact.relationship
  • Change binding strength value set from required http://terminology.hl7.org/ValueSet/v2-0131 to extensible http://hl7.org/fhir/ValueSet/patient-contactrelationship
Patient.contact.gender
  • Change value set from http://tools.ietf.org/html/bcp47 http://hl7.org/fhir/ValueSet/administrative-gender to http://hl7.org/fhir/ValueSet/languages http://hl7.org/fhir/ValueSet/administrative-gender|4.0.0
Patient.generalPractitioner Patient.communication.language
  • Renamed Change binding strength from careProvider extensible to generalPractitioner preferred
Patient.link.other Patient.generalPractitioner
  • Add Reference(RelatedPerson) No longer marked as Modifier Type Reference: Added Target Type PractitionerRole
Patient.link.type
  • No longer marked as Modifier Change value set from http://hl7.org/fhir/ValueSet/link-type to http://hl7.org/fhir/ValueSet/link-type|4.0.0
Patient.animal
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 18 16 tests that all execute ok. All tests pass round-trip testing and 6 all r3 resources are invalid (12 errors). ). valid.)

 

Alternate See the Profiles & Extensions and the alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

Path Definition Type Reference
Patient.gender
Patient.contact.gender
The gender of a person used for administrative purposes. Required AdministrativeGender
Patient.maritalStatus The domestic partnership status of a person. Extensible Marital Status Codes
Patient.contact.relationship The nature of the relationship between a patient and a contact person for that patient. Extensible v2 Contact Role Patient.animal.species The species of an animal. Example AnimalSpecies Patient.animal.breed The breed of an animal. Example AnimalBreeds Patient.animal.genderStatus The state of the animal's reproductive organs. Example GenderStatus PatientContactRelationship
Patient.communication.language A human language. Extensible Preferred , but limited to All Languages AllLanguages Common Languages CommonLanguages
Patient.link.type The type of link between this patient resource and another patient resource. Required LinkType

id Level Location Description Expression
pat-1 : On Patient.contact: Rule Patient.contact SHALL at least contain a contact's details or a reference to an organization ( expression on Patient.contact: name.exists() or telecom.exists() or address.exists() or organization.exists() )

Notes:

  • multipleBirth can be either expressed as a Boolean (just indicating whether the patient is part of a multiple birth) or as an integer, indicating the actual birth order.
  • Patient records may only be in one of two statuses: in use (active=true) and not in use (active=false). A normal record is active, i.e. it is in use. Active is set to 'false' when a record is created as a duplicate or in error. A record does not need to be linked to be inactivated.
  • The link element is used to assert that two or more Patient resources are both about the same actual patient. See below for further discussion
  • There should be only one preferred language (Language.preference = true) per mode of expression.
  • The Contact for a Patient has an element organization , this is for use with guardians or business related contacts where just the organization is relevant.

A Patient record's Resource Id can never change. For this reason reason, the identifiers with which humans are concerned (often called MRN - Medical Record Number, or UR - Unit Record) should not be used for the resource's id, since MRN's may change, i.e. as a result of having duplicate records of the same patient. Instead they should be represented in the Patient.identifier list where they can be managed. This is also useful for the case of institutions that have acquired multiple numbers because of mergers of patient record systems over time.

Where there is a need to implement an automated MRN Identifier created for a patient record, this could be achieved by providing an identifier in the patient with an appropriate assigner, MRN Type and/or system but with no value assigned. Internal business rules can then detect this and replace/populate this identifier with 1 or more identifiers (as required).

The link element is used to assert that patient resources refer to the same patient. This element is used to support the following scenarios where multiple patient records exist:

Managing Patient registration is a well known well-known difficult problem. Around 2% of registrations are in error, mostly duplicate records. Sometimes the duplicate record is caught fairly quickly and retired before much data is accumulated. In other cases, substantial amounts of data may accumulate. By using a link of type 'replaced-by', the record containing such a link is marked as a duplicate and the link points forward to a record that should be used instead. Note that the record pointed to may in its turn have been identified as created in error and forward to yet another Patient resource. Records that replace another record may use a link type of 'replaces' pointing to the old record.

A Patient record may be present in a system that acts as a Patient Index: it maintains a (summary of) patient data and a list of one or more servers that it are known to hold a more comprehensive and/or authorative authoritative record of the same patient. The link type 'refer' is used to denote such a link. Note that linked records may contain contradictory information. The record referred to does not point back to the referring record.

In a distributed architecture, multiple systems keep separate patient records concerning the same patient. These records are not considered duplicates, but contain a distributed, potentially overlapping view of the patient's data. Each such record may have its own focus or maintaining organization and there need not be a sense of one record being more complete or more authorative authoritative than another. In such cases, links of type 'see also' can be used to point to other patient records. It is not a requirement that such links are bilateral.

The Person resource on the surface appears to be very similar to the Patient resource, and the usage for it is very similar to using the Patient.Link capability.
The intention of the Person resource is to be able to link instances of resources together that are believed to be the same individual. This includes across resource types, such as RelatedPerson, Practitioner, Patient and even other Person resources.
The Patient Link however is only intended to be used for Patient resources.

The primary use case for the Person resource is to be able to support person registries that do not necessarily have a healthcare context, and are able to identify and quantify confidence levels that this is the same person.
This could include consumer portals where the maintainer of the person information is the actual person themselves.
A system could use the Person entry to cross check changes to information applied to one part of a record to values in another system; e.g., when moving, a consumer updates his contact numbers and address in his person record, and then a Patient Administration system is able to see that this data is changed and prompt the organization to follow up with the patient that was linked to the person record if they want their details updated, or if they no longer need services and they should be cancelled, as they've moved from the area.

The Linkage resource and the Patient.link property conceptually perform similar functions in FHIR, both provide an assertion of linkages between multiple resource instances that are referring to the same underlying individual.
When a Patient resource is linked/merged then it needs to have an internal indication that there is another patient resource that should be considered when referencing other records, which is achieved using the patient.link property.
Not detecting/checking for a potential linkage could mean that related clinical records are not discovered, potentially impacting patient safety. (which is why using the Linkage resource is not appropriate, as its use in this manner would force the use of either another query to potentially locate other patient resources to consider, or use _revInclude) _revinclude)

The contact element on the Patient Resource resource should be used for storing the details of people to contact information. Where a system has a separate record for other people for purposes other than just the contact details, contact. This information always travels with the RelatedPerson resource should Patient resource, and cannot be used. This includes cases where these used as the target of a reference. Where related people are actually contributing to the record, and need to be referenced individually by other resources (e.g. CarePlan.Participant, Encounter, DocumentReference, Appointment) where CarePlan.participant, Encounter.participant, DocumentReference.author, Appointment.participant), the Patient.Contact component cannot RelatedPerson resource must be used.

It is not expected that these records will be used for recording the primary care provider; this information should be stored in the Patient.generalPractitioner field.

Tracking Many systems and organizations only provide for a single attribute that aspires to represent all aspects of a patient's gender presents and sex with a number of challenges due to biological variations, differing cultural expectations single value. However, there are many considerations around sex and legal restrictions, gender documentation and interoperability. Listed below are the availability of various kinds of gender re-assignment. The basic gender included social and biological attributes that are relevant in Patient.gender has a limited use, the healthcare setting, as well as information on how each can be communicated.

  • Administrative Gender - in order to interoperate with systems that of use a single generic property, the basic Patient.gender property represents an administrative gender: the gender that the patient is considered to have for administration and record keeping purposes. This property is often used as an input to patient matching algorithms, for example.

In addition, addition to this administrative gender, other kinds of gender or sex properties may be represented:

  • Birth Clinical Sex - a testable observation about a biological property of the patient. There are several different types of clinical sex, including karyotypic/genetic/chromosomal, gonadal, ductal, phenotypic, etc. Clinical sex observations should be represented using Observation , qualified with the appropriate clinical codes from LOINC and/or SNOMED.
  • Clinical Gender - an observation about the patient, often collected as part of social history documentation, and represented as an Observation ( example ) using, for example, the LOINC code 76691-5 . Clinical gender observations can provide both history and confidentiality, where the genderIdentity extension does not.
  • Gender Identity - an indication from the patient about what gender they consider themselves to be. This can influence how the patient prefers to be addressed by care providers and other individuals. The standard genderIdentity extension may be used to communicate this property. This extension is appropriate when the gender identity is openly known.
  • Sex assigned at birth / Birth - the sex assigned at birth, as documented on the birth registration. Some countries allow variations such as not yet determined, unknown, or undifferentiated, while others do not. Some countries also allow birth registration information to be updated. The US realm defines a US Specific specific extension for this for Meaningful Use Clinical Gender - property. Alternatively, if you were representing this concept with an observation about the patient, typically using observation, you could use the LOINC code 76691-5 76689-9 ). LOINC also provides .
  • Legal Sex - regional and national entities often categorize citizens using a set single legal sex value. The legal sex of possible codes , or SNOMED CT has a patient can vary from region to region and country to country. A single patient may have multiple legal sex values at the descendents of 285116001 : Gender identity finding same time in different jurisdictions. In case where the Patient.gender administrative property is not sufficient to communicate legal sex, realm specific extensions should be used.

Other related Observations may describe the Karyotypic/Genetic, Gonadal, Ductal, Phenotypic status of a patient. For veterinary use use, the animal component extension also includes the genderStatus which indicates sterility information.

There are several ways to represent the relationship between a mother and a child. This is due to the when it is recorded and the purpose for which it is recorded:

  • To express the family relationship and legal responsibility thereof for administrative purposes: use the Patient/RelatedPerson structure.
    This structure is consistent over time.
  • To relate the encounter encounters of a mother and her baby for in a maternity encounter, for administrative and billing purposes: use the encounter.partof property
  • To collect information about the patient's relatives that might be relevant to the patient's medical condition: use the FamilyMemberHistory resource

During a maternity encounter, the Patient and Encounter resources for the mother will be present. After the child is born, new Patient, Encounter and RelatedPerson (for the mother) records will be created. The Child's encounter should reference the Mother's encounter using the partOf property.
The Patient/RelatedPerson structure should also be created for ongoing usage, as shown in this example:

<Patient>
	<id value="child"/>
	<!-- The details of the child -->
</Patient>
<RelatedPerson>
	<id value="rp-mom"/>
	<patient>
		<reference value="Patient/child"/>
	</patient>
</RelatedPerson>
<Patient>
	<id value="pat-mom"/>
	<!-- The details of the mom -->
	<link>
		<other value="rp-mom"/>
		<type value="see-also"/>
	</link>
</Patient>
<Encounter>
	<id value="mom-enc"/>
	<status value="in-progress"/>
	<class value="inpatient"/>
	<patient>
		<reference value="Patient/mom"/>
	</patient>
</Encounter>
<Encounter>
	<id value="child-enc"/>
	<status value="in-progress"/>
	<class value="inpatient"/>
	<patient>
		<reference value="Patient/child"/>
	</patient>
	<partOf>
		<reference value="Encounter/mom-enc"/>
	</partOf>
</Encounter>

This specification does not specify merge functionality: if multiple patient records are found to be duplicates, they can be linked together, as described above. These links merely express the relationship between records, and in the case of a replacement link, indicate a "master" record. This specification does not mandate that FHIR servers migrate information between such records on finding such a link. Note:

  • Health information administrators may call the process "merging", but it is often implemented as "linking" at the record level
  • Servers are allowed to implement merging/record migration even though it is not mandated.

STU Note: We are seeking input from the implementer community on what effect linking/merging/unlinking should have on other functionality such as the GET operation (where the result is the old version of the Patient), operation, searching, reverse includes, etc.; e.g., should observation resources from all linked/merged patients be returned when querying for one of them?
How should an unlink behavior be done? (Assuming that no data was "re-allocated" as part of merge) These suggested updated behaviors could be
How will the patient compartment interact with the merge?
This functionality and related behaviors is subject of to ongoing experimentation and implementation testing, with a definition to be proposed in a future connectathon. version of this specification.

Feedback here .

A Master Patient Index ( MPI ) is a service used to manage patient identification in a context where multiple patient databases exist. Healthcare applications and middleware use the MPI to match patients between the databases, and as new patient details are encountered. MPIs are highly specialized applications, often tailored extensively to the institution's particular mix of patients. MPIs can also be run on a regional and national basis.

To ask an MPI to match a patient, clients call the patient $match operation, which processes a parameters resource containing a complete or fragment of a patient resource, along with some other control parameters.
This provided patient resource does not need to pass full validation (mandatory fields, or invariants) as the resource will not be stored, it does however need to be a parsable instance.
The MPI can then use the properties of the resource as MPI inputs, and processed process them using an internal MPI algorithm of some kind to determine the most appropriate matches in the patient set. It does not have to use all the properties provided, and may ignore others provided quietly.
A specific profile (with the required fields/invariants) can be used to define what parameters the MPI algorithm requires.

  POST [base]/Patient/$match
  [some headers including content-type xml or json]
  [parameters body with patient resource inside]

The response from an "mpi" MPI $match operation is a set of patient records, ordered from most likely to least likely. If there are not patient matches, the MPI SHALL return an empty search set with no error, but may include an operation outcome with further advice. All patient records SHALL should have a score from 0 to 1, where 1 is the most certain match, along with an extension "match-grade" that indicates the MPI's position on the match quality:

  <entry> 
    <resource>
      <Patient>
        <!-- patient details -->
      </Patient>
    </resource>
    <search>
      <extension url="http://hl7.org/fhir/StructureDefinition/match-grade">
        <valueCode value="probable"/>
      </extension>
      <score value="0.80"/>
    </search>
  </entry> 

The match-grade extension has one of the following codes :

certain This record meets the matching criteria to be automatically considered as a full match.
probable This record is a close match, but not a certain match. Additional review (e.g. by a human) may be required before using this as a match.
possible This record may be a matching one. Additional review (e.g. by a human) SHOULD be performed before using this as a match.
certainly-not This record is known not to be a match. Note that usually non-matching records are not returned, but in some cases records previously or likely considered as a match may specifically be negated by the matching engine engine.

The purpose of using an MPI search versus a regular search is that the MPI search is really intended to target and find a specific single patient for recording information about reducing errors through incorrectly selecting the wrong patient. Often MPIs won't return data if there is insuffience insufficient search parameter data, such as a partial surname.
This compares to a regular search which can be used for finding lists of patients, such as to locate a group of patients that share a property in common, such as live in a specific location, or fit within an age range for performing population analysis.

A formal definition for the MPI $match operation is published.

Veterinary care is very much within the scope of FHIR, and the Patient resource can be used to communicate information about animal patients. To support this, there is a standard patient-animal extension which can be used for recording details about species, breed, and gender status. This extension is not intended to cover all relevant properties for veterinary care, and the use of additional domain-relevant extensions is expected for areas such as laboratory, zoological and livestock care.

The veterinary client ("owner") is represented using the RelatedPerson resource.

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
active TU token Whether the patient record is active Patient.active
address TU 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 3 Resources
address-city TU string A city specified in an address Patient.address.city 3 Resources
address-country TU string A country specified in an address Patient.address.country 3 Resources
address-postalcode TU string A postalCode specified in an address Patient.address.postalCode 3 Resources
address-state TU string A state specified in an address Patient.address.state 3 Resources
address-use TU token A use code specified in an address Patient.address.use 3 Resources
animal-breed token The breed for animal patients Patient.animal.breed animal-species token The species for animal patients Patient.animal.species birthdate TU date The patient's date of birth Patient.birthDate 2 Resources
death-date TU date The date of death has been provided and satisfies this search value Patient.deceased.as(DateTime) (Patient.deceased as dateTime)
deceased TU token This patient has been marked as deceased, or as a death date entered Patient.deceased.exists() and Patient.deceased != false
email TU token A value in an email contact Patient.telecom.where(system='email') 4 Resources
family TU string A portion of the family name of the patient Patient.name.family 1 Resources
gender TU token Gender of the patient Patient.gender 3 Resources
general-practitioner TU reference Patient's nominated general practitioner, not the organization that manages the record Patient.generalPractitioner
( Practitioner , Organization , PractitionerRole )
given TU string A portion of the given name of the patient Patient.name.given 1 Resources
identifier TU token A patient identifier Patient.identifier
language TU token Language code (irrespective of use value) Patient.communication.language
link TU reference All patients linked to the given patient Patient.link.other
( Patient , RelatedPerson )
name TU 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 TU reference The organization at which this person that is a the custodian of the patient record Patient.managingOrganization
( Organization )
phone TU token A value in a phone contact Patient.telecom.where(system='phone') 4 Resources
phonetic TU string A portion of either family or given name using some kind of phonetic matching algorithm Patient.name 3 Resources
telecom TU token The value in any kind of telecom details of the patient Patient.telecom 4 Resources