FHIR Extensions Pack v5.4.0 (2026-10-09)

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

8.1.47 Resource Patient - Extensions

Patient Administration Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: N/A Compartments: N/A

This table lists extensions for the Patient resource defined in association with the core specification. For background information, see Extensibility. Additional extensions may be found in published Implementation Guides and in the Conformance resource registry .

Identity Card. Type Context WG Status Δ v5.3.0
Extensions defined for the Patient resource
individual-genderIdentity 0..* (complex) Patient , RelatedPerson , Person , Practitioner , PractitionerRole , FamilyMemberHistory pa Trial-Use : FMM2 n/c
individual-pronouns 0..* (complex) Patient , RelatedPerson , Person , Practitioner pa Trial-Use : FMM1 n/c
individual-recordedSexOrGender 0..* (complex) Patient , RelatedPerson , Person , Practitioner , FamilyMemberHistory pa Trial-Use : FMM1 n/c
patient-adoptionInfo 0..1 CodeableConcept Patient pa Deprecated : FMM3 Added
patient-animal 0..1 (complex) Patient pa Trial-Use : FMM3 n/c
patient-birthPlace 0..1 Address Patient pa Trial-Use : FMM3 n/c
patient-birthTime 0..1 dateTime Patient.birthDate , Person.birthDate , RelatedPerson.birthDate , Practitioner.birthDate pa Trial-Use : FMM3 n/c
patient-bornStatus 0..1 code Patient pa Deprecated : FMM1 n/c
patient-cadavericDonor 0..1 boolean Patient pa Trial-Use : FMM3 n/c
patient-citizenship 0..* (complex) Patient , RelatedPerson , Person pa Trial-Use : FMM3 n/c
patient-congregation 0..1 string Patient pa Trial-Use : FMM3 n/c
patient-contactPriority 0..1 positiveInt Patient.contact , Organization.contact , ofType(ExtendedContactDetail) pa Deprecated : FMM1 n/c
patient-disability 0..* CodeableConcept Patient , RelatedPerson , Practitioner , Person pa Deprecated : FMM3 n/c
patient-fetalStatus 0..1 code Patient pc Draft : FMM1 n/c
patient-genderIdentity 0..1 CodeableConcept Patient pa Deprecated : FMM1 n/c
patient-importance 0..1 CodeableConcept Patient pa Trial-Use : FMM3 n/c
patient-interpreterRequired 0..1 boolean Patient , RelatedPerson , Encounter , Practitioner , Appointment , ServiceRequest pa Trial-Use : FMM3 n/c
patient-knownNonDuplicate 0..* Reference Patient pa Trial-Use : FMM1 n/c
patient-mothersMaidenName 0..1 string Patient pa Trial-Use : FMM3 n/c
patient-multipleBirthTotal 0..1 positiveInt Patient.multipleBirth[x] pa Trial-Use : FMM2 n/c
patient-nationality 0..* (complex) Patient , RelatedPerson , Person pa Trial-Use : FMM3 n/c
patient-preferenceType 0..* Coding Patient.communication.preferred , RelatedPerson.communication.preferred ,
Practitioner.communication.preferred , Person.communication.preferred 		pa Trial-Use : FMM3 n/c
patient-preferredPharmacy 0..* (complex) Patient , Encounter , PractitionerRole , Organization , Location pa Trial-Use : FMM0 n/c
patient-proficiency 0..* (complex) Patient.communication , RelatedPerson.communication , Practitioner.communication ,
Person.communication 		pa Trial-Use : FMM3 n/c
patient-relatedPerson 0..* Reference Patient.contact pa Trial-Use : FMM3 n/c
patient-religion 0..* CodeableConcept Patient pa Trial-Use : FMM3 n/c
patient-unknownIdentity 0..1 CodeableConcept Patient pa Trial-Use : FMM1 n/c
rank 0..1 canonical Address , Patient.contact , Organization.contact fhir Trial-Use : FMM1 n/c
Extensions defined for many resources including the Patient resource
datatype 0..1 string Base fhir Trial-Use : FMM2 n/c
additionalImplicitRules 0..* uri DomainResource fhir Trial-Use : FMM4 n/c
artifact-authoritativeSource 0..1 uri DomainResource cds Trial-Use : FMM1 n/c
artifact-extended-contact-detail 0..* ExtendedContactDetail Resource cds Trial-Use : FMM2 n/c
artifact-isOwned 0..1 boolean RelatedArtifact , ActivityDefinition.library , PlanDefinition.library ,
Measure.library , DomainResource.extension , type.exists() and type = 'composed-of' 		cds Trial-Use : FMM1 n/c
artifact-jurisdiction 0..* CodeableConcept Resource cds Trial-Use : FMM2 n/c
artifactassessment-disposition 0..1 code Resource cds Draft : FMM1 n/c
artifactassessment-workflowStatus 0..1 code Resource cds Draft : FMM1 n/c
cqf-artifactComment 0..* (complex) Resource cds Trial-Use : FMM3 n/c
cqf-citation 0..1 string Resource cds Trial-Use : FMM3 n/c
cqf-definitionTerm 0..1 (complex) Resource cds Trial-Use : FMM3 n/c
cqf-directReferenceCode 0..* Coding Resource cds Trial-Use : FMM2 n/c
cqf-knowledgeCapability 0..* code DomainResource cds Trial-Use : FMM2 n/c
cqf-knowledgeRepresentationLevel 0..* code DomainResource cds Trial-Use : FMM2 n/c
cqf-library 0..* canonical DomainResource cds Trial-Use : FMM3 n/c
cqf-logicDefinition 0..* (complex) DomainResource cds Trial-Use : FMM2 n/c
cqf-measureInfo 0..* (complex) Resource , Reference cds Trial-Use : FMM3 n/c
cqf-messages 0..* Reference Resource cds Trial-Use : FMM3 n/c
cqf-scope 0..1 string Resource cds Trial-Use : FMM1 n/c
derivation-reference 0..* (complex) Resource , Element fhir Trial-Use : FMM2 n/c
feature-assertion 0..* (complex) Resource fhir Trial-Use : FMM2 n/c
note 0..* Annotation Resource , Composition.section , Observation.component fhir Trial-Use : FMM1 n/c
obligations-profile 0..* (complex) Provenance.target , Resource.meta fhir Draft : FMM0 n/c
package-source 0..* (complex) Resource , Meta , RelatedArtifact fhir Trial-Use : FMM1 Changed (D)
patient-sexParameterForClinicalUse 0..* (complex) Resource pa Trial-Use : FMM1 Changed (M)
resource-instance-description 0..1 markdown Resource fhir Trial-Use : FMM2 n/c
resource-instance-name 0..1 string Resource fhir Trial-Use : FMM2 n/c
resource-pertainsToGoal 0..* Reference Resource fhir Trial-Use : FMM3 n/c
satisfies-requirement 0..* (complex) Resource , Element fhir Trial-Use : FMM2 n/c
structuredefinition-fmm 0..1 integer DomainResource , Element fhir Trial-Use : FMM3 n/c
structuredefinition-fmm-support 0..1 markdown DomainResource fhir Trial-Use : FMM2 n/c
structuredefinition-wg 0..1 code DomainResource fhir Trial-Use : FMM3 Changed (C)
version-specific-use 0..* (complex) Element , Resource fhir Trial-Use : FMM1 Changed (D)
version-specific-value 0..* (complex) Element , Resource fhir Trial-Use : FMM1 n/c
workflow-statusReason 0..* CodeableConcept DomainResource fhir Trial-Use : FMM2 n/c
Extensions that refer to the Patient resource
artifact-contactDetailReference 0..1 Reference ContactDetail cds Trial-Use : FMM2 n/c
artifactassessment-content 0..* (Choice) Basic cds Draft : FMM1 --
auditevent-OnBehalfOf 0..1 Reference AuditEvent.agent sec Draft : FMM1 n/c
biologicallyderivedproduct-intendedRecipient 0..1 Reference BiologicallyDerivedProduct oo Trial-Use : FMM0 n/c
consent-Transcriber 0..1 Reference Consent sec Trial-Use : FMM3 Changed (M)
consent-Witness 0..1 Reference Consent sec Trial-Use : FMM3 Changed (M)
cqf-initiatingPerson 0..1 Reference Basic cds Deprecated : FMM3 n/c
cqf-receivingPerson 0..1 Reference Basic cds Deprecated : FMM3 n/c
device-maintenanceresponsibility 0..* (complex) Device oo Draft : FMM0 n/c
documentreference-sourcepatient 0..1 Reference DocumentReference fhir Trial-Use : FMM2 Changed (M)
familymemberhistory-patient-record 0..* Reference FamilyMemberHistory pc Trial-Use : FMM3 n/c
goal-acceptance 0..* (complex) Goal pc Trial-Use : FMM3 n/c
list-for 0..* Reference List fhir Trial-Use : FMM2 n/c
patient-knownNonDuplicate 0..* Reference Patient pa Trial-Use : FMM1 n/c
procedure-directedBy 0..1 (Choice) Procedure , ServiceRequest pc Trial-Use : FMM3 n/c
questionnaireresponse-attester 0..* (complex) QuestionnaireResponse fhir Trial-Use : FMM2 n/c
questionnaireresponse-author 0..1 Reference QuestionnaireResponse.item , QuestionnaireResponse.item.item fhir Trial-Use : FMM3 n/c
request-performer 0..1 Reference RequestOrchestration , RequestGroup fhir Trial-Use : FMM1 Added
task-candidateList 0..* Reference Task oo Deprecated : FMM1 n/c
Extensions that refer to many resources including the Patient resource
alternate-reference 0..1 Reference Reference fhir Trial-Use : FMM2 n/c
artifact-reference 0..1 (Choice) Element cds Deprecated : FMM1 n/c
cqf-relativeDateTime 0..1 (complex) Element cds Deprecated : FMM3 n/c
diagnosticReport-focus 0..* Reference DiagnosticReport oo Draft : FMM0 n/c
event-basedOn 0..* Reference Condition , ChargeItem , ClinicalImpression , Composition , Consent , Coverage ,
EpisodeOfCare , ExplanationOfBenefit , FamilyMemberHistory , ImmunizationEvaluation ,
InventoryReport , MedicationStatement , PaymentNotice , PaymentReconciliation 		fhir Trial-Use : FMM3 n/c
event-partOf 0..* Reference DiagnosticReport , Condition fhir Trial-Use : FMM3 n/c
flag-detail 0..* Reference Flag , Media pc Trial-Use : FMM3 n/c
patient-sexParameterForClinicalUse 0..* (complex) Resource pa Trial-Use : FMM1 Changed (M)
replaces 0..* canonical ActorDefinition , CapabilityStatement , ChargeItemDefinition , CompartmentDefinition ,
ConditionDefinition , ExampleScenario , GraphDefinition , ImplementationGuide ,
MessageDefinition , ObservationDefinition , OperationDefinition , Questionnaire ,
Requirements , SearchParameter , SpecimenDefinition , StructureDefinition ,
StructureMap , SubscriptionTopic , TerminologyCapabilities , TestScript 		fhir Trial-Use : FMM3 n/c
request-replaces 0..* Reference NutritionOrder , SupplyRequest , Task fhir Trial-Use : FMM3 n/c
workflow-barrier 0..* CodeableReference Goal , CommunicationRequest , CarePlan.activity fhir Trial-Use : FMM2 Changed (D)
workflow-protectiveFactor 0..* CodeableReference Goal , CommunicationRequest , CarePlan.activity fhir Trial-Use : FMM2 Changed (D)
workflow-supportingInfo 0..* Reference DiagnosticReport , DocumentReference , Encounter , Observation , CommunicationRequest fhir Trial-Use : FMM3 n/c

100 Extensions

Extension Search Parameters

This table lists search parameters defined for any of the extensions listed above in association with the core specification.

  • Individual Gender Identity Parameter: Search based on individual's gender identity
  • age: Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search.
  • birth Order Boolean: Search based on whether a patient was part of a multiple birth or not.
  • mothers Maiden Name: Search based on patient's mother's maiden name