FHIR Extensions Pack v5.1.0-cibuild (2024-04-21)

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.1.0-cibuild 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: FMM2--
individual-pronouns0..*(complex)Patient, RelatedPerson, Person, PractitionerpaTrial-Use: FMM1--
individual-recordedSexOrGender0..*(complex)Patient, RelatedPerson, Person, PractitionerpaTrial-Use: FMM1--
patient-adoptionInfo0..1CodeableConceptPatientpaTrial-Use: FMM3--
patient-animal0..1(complex)PatientpaTrial-Use: FMM3--
patient-birthPlace0..1AddressPatientpaTrial-Use: FMM3--
patient-birthTime0..1dateTimePatient.birthDatepaTrial-Use: FMM3--
patient-bornStatus0..1codePatientpaDraft: FMM1--
patient-cadavericDonor0..1booleanPatientpaTrial-Use: FMM3--
patient-citizenship0..*(complex)PatientpaTrial-Use: FMM3--
patient-congregation0..1stringPatientpaTrial-Use: FMM3--
patient-contactPriority0..1positiveIntPatient.contactpaTrial-Use: FMM1--
patient-disability0..*CodeableConceptPatientpaTrial-Use: FMM3--
patient-importance0..1CodeableConceptPatientpaTrial-Use: FMM3--
patient-interpreterRequired0..1booleanPatientpaTrial-Use: FMM3--
patient-knownNonDuplicate0..*ReferencePatientpaTrial-Use: FMM1--
patient-mothersMaidenName0..1stringPatientpaTrial-Use: FMM3--
patient-multipleBirthTotal0..1positiveIntPatient.multipleBirth[x]paTrial-Use: FMM2--
patient-nationality0..*(complex)PatientpaTrial-Use: FMM3--
patient-preferenceType0..*CodingPatient.communication.preferredpaTrial-Use: FMM3--
patient-proficiency0..*(complex)Patient.communication, RelatedPerson.communication, Practitioner.communication,
Person.communication
paTrial-Use: FMM3--
patient-relatedPerson0..*ReferencePatient.contactpaTrial-Use: FMM3--
patient-religion0..*CodeableConceptPatientpaTrial-Use: FMM3--
patient-unknownIdentity0..1CodeableConceptPatientpaTrial-Use: FMM1--
Extensions defined for many resources including the Patient resource
datatype0..1stringBasefhirTrial-Use: FMM2--
artifact-approvalDate0..1dateResourcecdsTrial-Use: FMM1--
artifact-author0..*ContactDetailResourcecdsTrial-Use: FMM2--
artifact-citeAs0..1(Choice)ResourcecdsTrial-Use: FMM1--
artifact-contact0..*ContactDetailResourcecdsTrial-Use: FMM2--
artifact-copyright0..1markdownResourcecdsTrial-Use: FMM2--
artifact-copyrightLabel0..1stringResourcecdsDraft: FMM1--
artifact-date0..1dateTimeResourcecdsTrial-Use: FMM2--
artifact-description0..1markdownResourcecdsTrial-Use: FMM2--
artifact-effectivePeriod0..1PeriodResourcecdsTrial-Use: FMM1--
artifact-experimental0..1booleanResourcecdsTrial-Use: FMM2--
artifact-identifier0..*IdentifierResourcecdsTrial-Use: FMM2--
artifact-isOwned0..1booleanRelatedArtifact, ActivityDefinition.library, PlanDefinition.library,
Measure.library, DomainResource.extension, type.exists() and type = 'composed-of'
cdsTrial-Use: FMM1--
artifact-jurisdiction0..*CodeableConceptResourcecdsTrial-Use: FMM2--
artifact-lastReviewDate0..1dateResourcecdsTrial-Use: FMM1--
artifact-name0..1stringResourcecdsTrial-Use: FMM2--
artifact-publisher0..1stringResourcecdsTrial-Use: FMM2--
artifact-purpose0..1markdownResourcecdsTrial-Use: FMM2--
artifact-relatedArtifact0..*RelatedArtifactResourcecdsTrial-Use: FMM2--
artifact-releaseDescription0..1markdownResourcecdsTrial-Use: FMM1--
artifact-releaseLabel0..1stringResourcecdsTrial-Use: FMM1--
artifact-status0..1McodeResourcecdsTrial-Use: FMM2--
artifact-title0..1stringResourcecdsTrial-Use: FMM2--
artifact-topic0..*CodeableConceptResourcecdsTrial-Use: FMM2--
artifact-url0..1uriResourcecdsTrial-Use: FMM2--
artifact-usage0..1markdownResourcecdsTrial-Use: FMM1--
artifact-useContext0..*UsageContextResourcecdsTrial-Use: FMM2--
artifact-version0..1stringResourcecdsTrial-Use: FMM2--
artifact-versionAlgorithm0..1(Choice)ResourcecdsDraft: FMM1--
artifact-versionPolicy0..1CodeableConceptResourcecdsTrial-Use: FMM1--
artifactassessment-disposition0..1codeResourcecdsDraft: FMM1--
artifactassessment-workflowStatus0..1codeResourcecdsDraft: FMM1--
cqf-artifactComment0..*(complex)ResourcecdsTrial-Use: FMM3--
cqf-definitionTerm0..1(complex)ResourcecdsTrial-Use: FMM3--
cqf-directReferenceCode0..*CodingResourcecdsTrial-Use: FMM2--
cqf-knowledgeCapability0..*codeDomainResourcecdsTrial-Use: FMM2--
cqf-knowledgeRepresentationLevel0..*codeDomainResourcecdsTrial-Use: FMM2--
cqf-library0..*canonicalDomainResourcecdsTrial-Use: FMM3--
cqf-logicDefinition0..*(complex)DomainResourcecdsTrial-Use: FMM2--
cqf-measureInfo0..*(complex)Resource, ReferencecdsTrial-Use: FMM3--
cqf-messages0..*ReferenceResourcecdsTrial-Use: FMM3--
cqf-scope0..1stringResourcecdsTrial-Use: FMM1--
derivation-reference0..*(complex)Resource, ElementfhirTrial-Use: FMM2--
note0..*AnnotationResource, Composition.sectionfhirTrial-Use: FMM1--
patient-sexParameterForClinicalUse0..*(complex)ResourcepaDraft: FMM1--
resource-instance-description0..1markdownResourcefhirTrial-Use: FMM2--
resource-instance-name0..1stringResourcefhirTrial-Use: FMM2--
resource-pertainsToGoal0..*ReferenceResourcefhirTrial-Use: FMM3--
satisfies-requirement0..*(complex)Resource, ElementfhirTrial-Use: FMM2--
structuredefinition-fmm0..1integerDomainResource, ResourcefhirTrial-Use: FMM3--
structuredefinition-fmm-support0..1markdownDomainResourcefhirTrial-Use: FMM2--
structuredefinition-standards-status-reason0..1markdownDomainResource, http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-statusfhirDraft: FMM1--
structuredefinition-wg0..1codeDomainResourcefhirTrial-Use: FMM3--
version-specific-use0..*(complex)Element, ResourcefhirTrial-Use: FMM1--
version-specific-value0..*(complex)Element, ResourcefhirTrial-Use: FMM1--
Extensions that refer to the Patient resource
artifact-contactDetailReference0..1ReferenceContactDetailcdsTrial-Use: FMM2--
artifactassessment-content0..*(Choice)BasiccdsDraft: FMM1--
auditevent-OnBehalfOf0..1ReferenceAuditEvent.agentsecDraft: FMM1--
consent-Transcriber0..1ReferenceConsentcbccTrial-Use: FMM3--
consent-Witness0..1ReferenceConsentcbccTrial-Use: FMM3--
cqf-initiatingPerson0..1ReferenceBasiccdsDeprecated: FMM3--
cqf-receivingPerson0..1ReferenceBasiccdsDeprecated: FMM3--
documentreference-sourcepatient0..1ReferenceDocumentReferenceooTrial-Use: FMM2--
familymemberhistory-patient-record0..*ReferenceFamilyMemberHistorypcTrial-Use: FMM3--
goal-acceptance0..*(complex)GoalpcTrial-Use: FMM3--
list-for0..*ReferenceListfhirTrial-Use: FMM2--
patient-knownNonDuplicate0..*ReferencePatientpaTrial-Use: FMM1--
procedure-directedBy0..1(Choice)Procedure, ServiceRequestpcTrial-Use: FMM3--
questionnaireresponse-attester0..*(complex)QuestionnaireResponsefhirTrial-Use: FMM2--
questionnaireresponse-author0..1ReferenceQuestionnaireResponse.item, QuestionnaireResponse.item.itemfhirTrial-Use: FMM3--
Extensions that refer to many resources including the Patient resource
alternate-reference0..1ReferenceReferencefhirTrial-Use: FMM2--
artifact-reference0..1(Choice)ElementcdsTrial-Use: FMM1--
cqf-relativeDateTime0..1(complex)ElementcdsDeprecated: FMM3--
diagnosticReport-focus0..*ReferenceDiagnosticReportooDraft: FMM0--
event-basedOn0..*ReferenceCondition, ChargeItem, ClinicalImpression, Composition, Consent, Coverage,
DetectedIssue, EpisodeOfCare, ExplanationOfBenefit, FamilyMemberHistory,
ImmunizationEvaluation, InventoryReport, MedicationStatement, PaymentNotice,
PaymentReconciliation
fhirTrial-Use: FMM3--
event-partOf0..*ReferenceDiagnosticReport, ConditionfhirTrial-Use: FMM3--
flag-detail0..*ReferenceFlagpcTrial-Use: FMM3--
patient-sexParameterForClinicalUse0..*(complex)ResourcepaDraft: FMM1--
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: FMM3--
request-replaces0..*ReferenceNutritionOrder, SupplyRequest, TaskfhirTrial-Use: FMM3--
workflow-barrier0..*CodeableReferenceGoal, CommunicationRequest, CarePlan.activityfhirTrial-Use: FMM2--
workflow-protectiveFactor0..*CodeableReferenceGoal, CommunicationRequest, CarePlan.activityfhirTrial-Use: FMM2--
workflow-supportingInfo0..*ReferenceDiagnosticReport, DocumentReference, Encounter, Observation, CommunicationRequestfhirTrial-Use: FMM3--

Extension Search Parameters

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

  • 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