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
This table lists extensions for the DocumentReference 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. | Type | Context | WG | Status | Δ v1.0.0 |
Extensions defined for the DocumentReference resource |
documentreference-sourcepatient | 0..1 | Reference | DocumentReference | oo | Trial-Use: FMM2 | Changed: |
documentreference-thumbnail | 0..1 | boolean | DocumentReference.content | oo | Trial-Use: FMM2 | Changed: |
event-location | 0..1 | Reference | Observation, DiagnosticReport, DocumentReference, SupplyDelivery | fhir | Trial-Use: FMM3 | n/c |
event-performerFunction | 0..1 | CodeableConcept | Observation.performer, DiagnosticReport.performer, DocumentReference.author, Consent.grantee | fhir | Trial-Use: FMM3 | n/c |
event-statusReason | 0..1 | CodeableConcept | Observation, DiagnosticReport, DocumentReference, SupplyDelivery, DeviceUsage | fhir | Trial-Use: FMM3 | Changed: |
workflow-adheresTo | 0..* | (Choice) | Condition, Communication, DiagnosticReport, DocumentReference, Encounter, FamilyMemberHistory, Immunization, ImmunizationEvaluation, Observation, QuestionnaireResponse, SupplyDelivery | fhir | Trial-Use: FMM2 | n/c |
workflow-episodeOfCare | 0..* | Reference | AdverseEvent, Appointment, Basic, CarePlan, ClinicalImpression, Communication, CommunicationRequest, Composition, Condition, Consent, DetectedIssue, DeviceRequest, DeviceUsage, DiagnosticReport, DocumentReference, EnrollmentRequest, EnrollmentResponse, FamilyMemberHistory, Flag, Goal, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, Invoice, List, MeasureReport, MedicationAdministration, MedicationDispense, MedicationRequest, MedicationStatement, MolecularSequence, NutritionIntake, NutritionOrder, Observation, Procedure, QuestionnaireResponse, RequestOrchestration, ResearchSubject, RiskAssessment, SupplyDelivery, SupplyRequest, VisionPrescription, ServiceRequest, ChargeItem | fhir | Trial-Use: FMM3 | n/c |
workflow-reason | 0..* | CodeableReference | Observation, DiagnosticReport, DocumentReference, NutritionOrder | fhir | Trial-Use: FMM2 | n/c |
workflow-researchStudy | 0..* | Reference | Composition, Consent, DeviceUsage, DiagnosticReport, Encounter, FamilyMemberHistory, Immunization, DocumentReference, MedicationAdministration, MedicationDispense, MedicationStatement, Observation, Procedure, QuestionnaireResponse, RiskAssessment, ServiceRequest, SupplyDelivery, Task | fhir | Trial-Use: FMM3 | n/c |
workflow-shallComplyWith | 0..* | (Choice) | ActivityDefinition, Measure, OperationDefinition, PlanDefinition, Observation, DiagnosticReport, DocumentReference, Condition, SupplyDelivery, CommunicationRequest, SupplyRequest | fhir | Trial-Use: FMM2 | n/c |
workflow-supportingInfo | 0..* | Reference | DiagnosticReport, DocumentReference, Encounter, Observation, CommunicationRequest | fhir | Trial-Use: FMM3 | n/c |
workflow-triggeredBy | 0..1 | (Choice) | CarePlan, CarePlan.activity.plannedActivityDetail, CommunicationRequest, DeviceRequest, Encounter, ImmunizationRecommendation, NutritionOrder, RequestOrchestration, SupplyRequest, ServiceRequest, Task, Condition, Communication, DiagnosticReport, DocumentReference, FamilyMemberHistory, Immunization, Observation, QuestionnaireResponse, SupplyDelivery | fhir | Trial-Use: FMM2 | n/c |
Extensions defined for many resources including the DocumentReference resource |
datatype | 0..1 | string | Base | fhir | Trial-Use: FMM2 | n/c |
artifact-approvalDate | 0..1 | date | Resource | cds | Trial-Use: FMM1 | Added: |
artifact-author | 0..* | ContactDetail | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-citeAs | 0..1 | (Choice) | Resource | cds | Trial-Use: FMM1 | Added: |
artifact-contact | 0..* | ContactDetail | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-copyright | 0..1 | markdown | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-copyrightLabel | 0..1 | string | Resource | cds | Experimental Draft: FMM1 | Changed: |
artifact-date | 0..1 | dateTime | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-description | 0..1 | markdown | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-effectivePeriod | 0..1 | Period | Resource | cds | Trial-Use: FMM1 | Added: |
artifact-experimental | 0..1 | boolean | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-identifier | 0..* | Identifier | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-isOwned | 0..1 | boolean | RelatedArtifact, ActivityDefinition.library, PlanDefinition.library, Measure.library, DomainResource.extension, type.exists() and type = 'composed-of' | cds | Trial-Use: FMM1 | Added: |
artifact-jurisdiction | 0..* | CodeableConcept | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-lastReviewDate | 0..1 | date | Resource | cds | Trial-Use: FMM1 | Added: |
artifact-name | 0..1 | string | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-publisher | 0..1 | string | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-purpose | 0..1 | markdown | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-relatedArtifact | 0..* | RelatedArtifact | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-releaseDescription | 0..1 | markdown | Resource | cds | Trial-Use: FMM1 | Added: |
artifact-releaseLabel | 0..1 | string | Resource | cds | Trial-Use: FMM1 | Added: |
artifact-status | 0..1M | code | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-title | 0..1 | string | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-topic | 0..* | CodeableConcept | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-url | 0..1 | uri | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-usage | 0..1 | markdown | Resource | cds | Trial-Use: FMM1 | Added: |
artifact-useContext | 0..* | UsageContext | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-version | 0..1 | string | Resource | cds | Trial-Use: FMM2 | Changed: |
artifact-versionAlgorithm | 0..1 | (Choice) | Resource | cds | Draft: FMM1 | Changed: |
artifact-versionPolicy | 0..1 | CodeableConcept | Resource | cds | Trial-Use: FMM1 | Added: |
artifactassessment-disposition | 0..1 | code | Resource | cds | Draft: FMM1 | Added: |
artifactassessment-workflowStatus | 0..1 | code | Resource | cds | Draft: FMM1 | Added: |
cqf-artifactComment | 0..* | (complex) | Resource | cds | Trial-Use: FMM3 | Changed: |
cqf-definitionTerm | 0..1 | (complex) | Resource | cds | Trial-Use: FMM3 | Added: |
cqf-directReferenceCode | 0..* | Coding | Resource | cds | Trial-Use: FMM2 | Changed: |
cqf-knowledgeCapability | 0..* | code | DomainResource | cds | Trial-Use: FMM2 | Changed: |
cqf-knowledgeRepresentationLevel | 0..* | code | DomainResource | cds | Trial-Use: FMM2 | Changed: |
cqf-library | 0..* | canonical | DomainResource | cds | Trial-Use: FMM3 | Changed: |
cqf-logicDefinition | 0..* | (complex) | DomainResource | cds | Trial-Use: FMM2 | Changed: |
cqf-measureInfo | 0..* | (complex) | Resource, Reference | cds | Trial-Use: FMM3 | Changed: |
cqf-messages | 0..* | Reference | Resource | cds | Trial-Use: FMM3 | Added: |
cqf-scope | 0..1 | string | Resource | cds | Trial-Use: FMM1 | Added: |
derivation-reference | 0..* | (complex) | Resource, Element | fhir | Trial-Use: FMM2 | n/c |
feature-assertion | 0..* | Coding | Provenance.target, Resource.meta | fhir | Experimental Draft: FMM0 | Added: |
note | 0..* | Annotation | Resource, Composition.section | fhir | Trial-Use: FMM1 | Added: |
obligations-profile | 0..* | (complex) | Provenance.target, Resource.meta | fhir | Experimental Draft: FMM0 | Added: |
patient-sexParameterForClinicalUse | 0..* | (complex) | Resource | pa | Experimental Draft: FMM1 | Changed: |
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 | Changed: |
structuredefinition-fmm | 0..1 | integer | DomainResource, Resource | fhir | Trial-Use: FMM3 | n/c |
structuredefinition-fmm-support | 0..1 | markdown | DomainResource | fhir | Trial-Use: FMM2 | n/c |
structuredefinition-standards-status-reason | 0..1 | markdown | DomainResource, http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status | fhir | Experimental Draft: FMM1 | n/c |
structuredefinition-wg | 0..1 | code | DomainResource | fhir | Trial-Use: FMM3 | n/c |
version-specific-use | 0..* | (complex) | Element, Resource | fhir | Trial-Use: FMM1 | Added: |
version-specific-value | 0..* | (complex) | Element, Resource | fhir | Trial-Use: FMM1 | Added: |
Extensions that refer to the DocumentReference resource |
individual-recordedSexOrGender | 0..* | (complex) | Patient, RelatedPerson, Person, Practitioner | pa | Trial-Use: FMM1 | Changed: |
workflow-reason | 0..* | CodeableReference | Observation, DiagnosticReport, DocumentReference, NutritionOrder | fhir | Trial-Use: FMM2 | n/c |
Extensions that refer to many resources including the DocumentReference resource |
alternate-reference | 0..1 | Reference | Reference | fhir | Trial-Use: FMM2 | n/c |
artifact-reference | 0..1 | (Choice) | Element | cds | Trial-Use: FMM1 | Added: |
cqf-relativeDateTime | 0..1 | (complex) | Element | cds | Deprecated: FMM3 | Changed: |
diagnosticReport-focus | 0..* | Reference | DiagnosticReport | oo | Experimental Draft: FMM0 | Changed: |
event-basedOn | 0..* | Reference | Condition, ChargeItem, ClinicalImpression, Composition, Consent, Coverage, DetectedIssue, 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 | pc | Trial-Use: FMM3 | Changed: |
patient-sexParameterForClinicalUse | 0..* | (complex) | Resource | pa | Experimental Draft: FMM1 | Changed: |
replaces | 0..* | canonical | ActivityDefinition, 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 | 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 | n/c |
workflow-protectiveFactor | 0..* | CodeableReference | Goal, CommunicationRequest, CarePlan.activity | fhir | Trial-Use: FMM2 | n/c |
workflow-supportingInfo | 0..* | Reference | DiagnosticReport, DocumentReference, Encounter, Observation, CommunicationRequest | fhir | Trial-Use: FMM3 | n/c |
This table lists search parameters defined for any of the extensions listed above in association with the core specification.