FHIR Extensions Pack v5.2.0-ballot (2024-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.2.0-ballot 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

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 Conf.TypeContextWGStatusΔ v1.0.0
Extensions defined for the Patient resource
individual-genderIdentity0..*(complex)Patient, RelatedPerson, Person, Practitioner, PractitionerRolepaTrial-Use: FMM2icon Changed:
individual-pronouns0..*(complex)Patient, RelatedPerson, Person, PractitionerpaTrial-Use: FMM1icon Changed:
individual-recordedSexOrGender0..*(complex)Patient, RelatedPerson, Person, PractitionerpaTrial-Use: FMM1icon Changed:
patient-adoptionInfo0..1CodeableConceptPatientpaTrial-Use: FMM3icon Changed:
patient-animal0..1(complex)PatientpaTrial-Use: FMM3icon Changed:
patient-birthPlace0..1AddressPatientpaTrial-Use: FMM3icon Changed:
patient-birthTime0..1dateTimePatient.birthDatepaTrial-Use: FMM3icon Changed:
patient-bornStatus0..1codePatientpaDeprecated: FMM1icon Changed:
patient-cadavericDonor0..1booleanPatientpaTrial-Use: FMM3icon Changed:
patient-citizenship0..*(complex)PatientpaTrial-Use: FMM3icon Changed:
patient-congregation0..1stringPatientpaTrial-Use: FMM3icon Changed:
patient-contactPriority0..1positiveIntPatient.contactpaTrial-Use: FMM1icon Added:
patient-disability0..*CodeableConceptPatientpaTrial-Use: FMM3icon Changed:
patient-fetalStatus0..1codePatientpcExperimental
Draft: FMM1
icon Added:
patient-importance0..1CodeableConceptPatientpaTrial-Use: FMM3icon Changed:
patient-interpreterRequired0..1booleanPatientpaTrial-Use: FMM3icon Changed:
patient-knownNonDuplicate0..*ReferencePatientpaTrial-Use: FMM1icon Added:
patient-mothersMaidenName0..1stringPatientpaTrial-Use: FMM3icon Changed:
patient-multipleBirthTotal0..1positiveIntPatient.multipleBirth[x]paTrial-Use: FMM2icon Changed:
patient-nationality0..*(complex)PatientpaTrial-Use: FMM3icon Changed:
patient-preferenceType0..*CodingPatient.communication.preferredpaTrial-Use: FMM3icon Changed:
patient-preferredPharmacy0..*(complex)Patient, Encounter, PractitionerRole, Organization, LocationpaTrial-Use: FMM0icon Added:
patient-proficiency0..*(complex)Patient.communication, RelatedPerson.communication, Practitioner.communication,
Person.communication
paTrial-Use: FMM3icon Changed:
patient-relatedPerson0..*ReferencePatient.contactpaTrial-Use: FMM3icon Changed:
patient-religion0..*CodeableConceptPatientpaTrial-Use: FMM3icon Changed:
patient-unknownIdentity0..1CodeableConceptPatientpaTrial-Use: FMM1icon Added:
Extensions defined for many resources including the Patient resource
datatype0..1stringBasefhirTrial-Use: FMM2n/c
artifact-approvalDate0..1dateResourcecdsTrial-Use: FMM1icon Added:
artifact-author0..*ContactDetailResourcecdsTrial-Use: FMM2icon Changed:
artifact-citeAs0..1(Choice)ResourcecdsTrial-Use: FMM1icon Added:
artifact-contact0..*ContactDetailResourcecdsTrial-Use: FMM2icon Changed:
artifact-copyright0..1markdownResourcecdsTrial-Use: FMM2icon Changed:
artifact-copyrightLabel0..1stringResourcecdsExperimental
Draft: FMM1
icon Changed:
artifact-date0..1dateTimeResourcecdsTrial-Use: FMM2icon Changed:
artifact-description0..1markdownResourcecdsTrial-Use: FMM2icon Changed:
artifact-effectivePeriod0..1PeriodResourcecdsTrial-Use: FMM1icon Added:
artifact-experimental0..1booleanResourcecdsTrial-Use: FMM2icon Changed:
artifact-identifier0..*IdentifierResourcecdsTrial-Use: FMM2icon Changed:
artifact-isOwned0..1booleanRelatedArtifact, ActivityDefinition.library, PlanDefinition.library,
Measure.library, DomainResource.extension, type.exists() and type = 'composed-of'
cdsTrial-Use: FMM1icon Added:
artifact-jurisdiction0..*CodeableConceptResourcecdsTrial-Use: FMM2icon Changed:
artifact-lastReviewDate0..1dateResourcecdsTrial-Use: FMM1icon Added:
artifact-name0..1stringResourcecdsTrial-Use: FMM2icon Changed:
artifact-publisher0..1stringResourcecdsTrial-Use: FMM2icon Changed:
artifact-purpose0..1markdownResourcecdsTrial-Use: FMM2icon Changed:
artifact-relatedArtifact0..*RelatedArtifactResourcecdsTrial-Use: FMM2icon Changed:
artifact-releaseDescription0..1markdownResourcecdsTrial-Use: FMM1icon Added:
artifact-releaseLabel0..1stringResourcecdsTrial-Use: FMM1icon Added:
artifact-status0..1McodeResourcecdsTrial-Use: FMM2icon Changed:
artifact-title0..1stringResourcecdsTrial-Use: FMM2icon Changed:
artifact-topic0..*CodeableConceptResourcecdsTrial-Use: FMM2icon Changed:
artifact-url0..1uriResourcecdsTrial-Use: FMM2icon Changed:
artifact-usage0..1markdownResourcecdsTrial-Use: FMM1icon Added:
artifact-useContext0..*UsageContextResourcecdsTrial-Use: FMM2icon Changed:
artifact-version0..1stringResourcecdsTrial-Use: FMM2icon Changed:
artifact-versionAlgorithm0..1(Choice)ResourcecdsDraft: FMM1icon Changed:
artifact-versionPolicy0..1CodeableConceptResourcecdsTrial-Use: FMM1icon Added:
artifactassessment-disposition0..1codeResourcecdsDraft: FMM1icon Added:
artifactassessment-workflowStatus0..1codeResourcecdsDraft: FMM1icon Added:
cqf-artifactComment0..*(complex)ResourcecdsTrial-Use: FMM3icon Changed:
cqf-definitionTerm0..1(complex)ResourcecdsTrial-Use: FMM3icon Added:
cqf-directReferenceCode0..*CodingResourcecdsTrial-Use: FMM2icon Changed:
cqf-knowledgeCapability0..*codeDomainResourcecdsTrial-Use: FMM2icon Changed:
cqf-knowledgeRepresentationLevel0..*codeDomainResourcecdsTrial-Use: FMM2icon Changed:
cqf-library0..*canonicalDomainResourcecdsTrial-Use: FMM3icon Changed:
cqf-logicDefinition0..*(complex)DomainResourcecdsTrial-Use: FMM2icon Changed:
cqf-measureInfo0..*(complex)Resource, ReferencecdsTrial-Use: FMM3icon Changed:
cqf-messages0..*ReferenceResourcecdsTrial-Use: FMM3icon Added:
cqf-scope0..1stringResourcecdsTrial-Use: FMM1icon Added:
derivation-reference0..*(complex)Resource, ElementfhirTrial-Use: FMM2n/c
feature-assertion0..*CodingProvenance.target, Resource.metafhirExperimental
Draft: FMM0
icon Added:
note0..*AnnotationResource, Composition.sectionfhirTrial-Use: FMM1icon Added:
obligations-profile0..*(complex)Provenance.target, Resource.metafhirExperimental
Draft: FMM0
icon Added:
patient-sexParameterForClinicalUse0..*(complex)ResourcepaExperimental
Draft: FMM1
icon Changed:
resource-instance-description0..1markdownResourcefhirTrial-Use: FMM2n/c
resource-instance-name0..1stringResourcefhirTrial-Use: FMM2n/c
resource-pertainsToGoal0..*ReferenceResourcefhirTrial-Use: FMM3n/c
satisfies-requirement0..*(complex)Resource, ElementfhirTrial-Use: FMM2icon Changed:
structuredefinition-fmm0..1integerDomainResource, ResourcefhirTrial-Use: FMM3n/c
structuredefinition-fmm-support0..1markdownDomainResourcefhirTrial-Use: FMM2n/c
structuredefinition-standards-status-reason0..1markdownDomainResource, http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-statusfhirExperimental
Draft: FMM1
n/c
structuredefinition-wg0..1codeDomainResourcefhirTrial-Use: FMM3n/c
version-specific-use0..*(complex)Element, ResourcefhirTrial-Use: FMM1icon Added:
version-specific-value0..*(complex)Element, ResourcefhirTrial-Use: FMM1icon Added:
Extensions that refer to the Patient resource
artifact-contactDetailReference0..1ReferenceContactDetailcdsTrial-Use: FMM2icon Changed:
artifactassessment-content0..*(Choice)BasiccdsDraft: FMM1icon Added:
auditevent-OnBehalfOf0..1ReferenceAuditEvent.agentsecExperimental
Draft: FMM1
icon Changed:
consent-Transcriber0..1ReferenceConsentcbccTrial-Use: FMM3icon Changed:
consent-Witness0..1ReferenceConsentcbccTrial-Use: FMM3icon Changed:
cqf-initiatingPerson0..1ReferenceBasiccdsDeprecated: FMM3icon Changed:
cqf-receivingPerson0..1ReferenceBasiccdsDeprecated: FMM3icon Changed:
documentreference-sourcepatient0..1ReferenceDocumentReferenceooTrial-Use: FMM2icon Changed:
familymemberhistory-patient-record0..*ReferenceFamilyMemberHistorypcTrial-Use: FMM3icon Changed:
goal-acceptance0..*(complex)GoalpcTrial-Use: FMM3icon Changed:
list-for0..*ReferenceListfhirTrial-Use: FMM2n/c
patient-knownNonDuplicate0..*ReferencePatientpaTrial-Use: FMM1icon Added:
procedure-directedBy0..1(Choice)Procedure, ServiceRequestpcTrial-Use: FMM3icon Changed:
questionnaireresponse-attester0..*(complex)QuestionnaireResponsefhirTrial-Use: FMM2icon Changed:
questionnaireresponse-author0..1ReferenceQuestionnaireResponse.item, QuestionnaireResponse.item.itemfhirTrial-Use: FMM3n/c
Extensions that refer to many resources including the Patient resource
alternate-reference0..1ReferenceReferencefhirTrial-Use: FMM2n/c
artifact-reference0..1(Choice)ElementcdsTrial-Use: FMM1icon Added:
cqf-relativeDateTime0..1(complex)ElementcdsDeprecated: FMM3icon Changed:
diagnosticReport-focus0..*ReferenceDiagnosticReportooExperimental
Draft: FMM0
icon Changed:
event-basedOn0..*ReferenceCondition, ChargeItem, ClinicalImpression, Composition, Consent, Coverage,
DetectedIssue, EpisodeOfCare, ExplanationOfBenefit, FamilyMemberHistory,
ImmunizationEvaluation, InventoryReport, MedicationStatement, PaymentNotice,
PaymentReconciliation
fhirTrial-Use: FMM3n/c
event-partOf0..*ReferenceDiagnosticReport, ConditionfhirTrial-Use: FMM3n/c
flag-detail0..*ReferenceFlagpcTrial-Use: FMM3icon Changed:
patient-sexParameterForClinicalUse0..*(complex)ResourcepaExperimental
Draft: FMM1
icon Changed:
replaces0..*canonicalActivityDefinition, ActorDefinition, CapabilityStatement, ChargeItemDefinition,
Citation, CodeSystem, CompartmentDefinition, ConceptMap, ConditionDefinition,
EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario,
GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition,
NamingSystem, ObservationDefinition, OperationDefinition, PlanDefinition,
Questionnaire, Requirements, SearchParameter, SpecimenDefinition,
StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities,
TestScript, ValueSet
fhirTrial-Use: FMM3n/c
request-replaces0..*ReferenceNutritionOrder, SupplyRequest, TaskfhirTrial-Use: FMM3n/c
workflow-barrier0..*CodeableReferenceGoal, CommunicationRequest, CarePlan.activityfhirTrial-Use: FMM2n/c
workflow-protectiveFactor0..*CodeableReferenceGoal, CommunicationRequest, CarePlan.activityfhirTrial-Use: FMM2n/c
workflow-supportingInfo0..*ReferenceDiagnosticReport, DocumentReference, Encounter, Observation, CommunicationRequestfhirTrial-Use: FMM3n/c

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: 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