Reference

A reference from one resource to another. If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

type Reference implements Element {
  reference: String
  type: Uri
  identifier: Identifier
  display: String
  extension: [Extension]
  id: String
  _resolvedResource: Resource
}

Fields

Reference.reference ● String scalar

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with # ) refer to contained resources.

Reference.type ● Uri scalar

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. Patient is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Reference.identifier ● Identifier object

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Reference.display ● String scalar

Plain text narrative that identifies the resource in addition to the resource reference.

Reference.extension ● [Extension] list object

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Reference.id ● String scalar

Reference._resolvedResource ● Resource interface

Resolves a referenced resource in place

Interfaces

Element interface

Base definition for all elements in a resource. If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Returned By

AccountDelete mutation ● ActivityDefinitionDelete mutation ● AdministrableProductDefinitionDelete mutation ● AdverseEventDelete mutation ● AllergyIntoleranceDelete mutation ● AppointmentDelete mutation ● AppointmentResponseDelete mutation ● AuditEventDelete mutation ● BasicDelete mutation ● BinaryDelete mutation ● BiologicallyDerivedProductDelete mutation ● BodyStructureDelete mutation ● CarePlanDelete mutation ● CareTeamDelete mutation ● CatalogEntryDelete mutation ● ChargeItemDefinitionDelete mutation ● ChargeItemDelete mutation ● CitationDelete mutation ● ClaimDelete mutation ● ClaimResponseDelete mutation ● ClinicalImpressionDelete mutation ● ClinicalUseDefinitionDelete mutation ● CodeSystemDelete mutation ● CommunicationDelete mutation ● CommunicationRequestDelete mutation ● CompartmentDefinitionDelete mutation ● CompositionDelete mutation ● ConceptMapDelete mutation ● ConditionDelete mutation ● ConsentDelete mutation ● ContractDelete mutation ● CoverageDelete mutation ● CoverageEligibilityRequestDelete mutation ● CoverageEligibilityResponseDelete mutation ● DetectedIssueDelete mutation ● DeviceDefinitionDelete mutation ● DeviceDelete mutation ● DeviceMetricDelete mutation ● DeviceRequestDelete mutation ● DeviceUseStatementDelete mutation ● DiagnosticReportDelete mutation ● DocumentManifestDelete mutation ● DocumentReferenceDelete mutation ● EncounterDelete mutation ● EndpointDelete mutation ● EnrollmentRequestDelete mutation ● EnrollmentResponseDelete mutation ● EpisodeOfCareDelete mutation ● EventDefinitionDelete mutation ● EvidenceReportDelete mutation ● ExampleScenarioDelete mutation ● ExplanationOfBenefitDelete mutation ● FamilyMemberHistoryDelete mutation ● FlagDelete mutation ● GoalDelete mutation ● GraphDefinitionDelete mutation ● GroupDelete mutation ● GuidanceResponseDelete mutation ● HealthcareServiceDelete mutation ● ImagingStudyDelete mutation ● ImmunizationDelete mutation ● ImmunizationEvaluationDelete mutation ● ImmunizationRecommendationDelete mutation ● ImplementationGuideDelete mutation ● IngredientDelete mutation ● InsurancePlanDelete mutation ● InvoiceDelete mutation ● LibraryDelete mutation ● LinkageDelete mutation ● ListDelete mutation ● LocationDelete mutation ● ManufacturedItemDefinitionDelete mutation ● Me query ● MeasureDelete mutation ● MeasureReportDelete mutation ● MediaDelete mutation ● MedicationAdministrationDelete mutation ● MedicationDelete mutation ● MedicationDispenseDelete mutation ● MedicationKnowledgeDelete mutation ● MedicationRequestDelete mutation ● MedicationStatementDelete mutation ● MedicinalProductDefinitionDelete mutation ● MessageDefinitionDelete mutation ● MessageHeaderDelete mutation ● MolecularSequenceDelete mutation ● NamingSystemDelete mutation ● NutritionOrderDelete mutation ● NutritionProductDelete mutation ● ObservationDefinitionDelete mutation ● ObservationDelete mutation ● OperationDefinitionDelete mutation ● OperationOutcomeDelete mutation ● OrganizationAffiliationDelete mutation ● OrganizationDelete mutation ● PackagedProductDefinitionDelete mutation ● PatientDelete mutation ● PaymentNoticeDelete mutation ● PaymentReconciliationDelete mutation ● PersonDelete mutation ● PlanDefinitionDelete mutation ● PractitionerDelete mutation ● PractitionerRoleDelete mutation ● ProcedureDelete mutation ● ProvenanceDelete mutation ● QuestionnaireDelete mutation ● QuestionnaireResponseDelete mutation ● RegulatedAuthorizationDelete mutation ● RelatedPersonDelete mutation ● RequestGroupDelete mutation ● ResearchDefinitionDelete mutation ● ResearchElementDefinitionDelete mutation ● ResearchStudyDelete mutation ● ResearchSubjectDelete mutation ● RiskAssessmentDelete mutation ● ScheduleDelete mutation ● SearchParameterDelete mutation ● ServiceRequestDelete mutation ● SlotDelete mutation ● SpecimenDefinitionDelete mutation ● SpecimenDelete mutation ● StructureDefinitionDelete mutation ● StructureMapDelete mutation ● SubscriptionStatusDelete mutation ● SubscriptionTopicDelete mutation ● SubstanceDefinitionDelete mutation ● SubstanceDelete mutation ● SupplyDeliveryDelete mutation ● SupplyRequestDelete mutation ● TaskDelete mutation ● TerminologyCapabilitiesDelete mutation ● TestReportDelete mutation ● TestScriptDelete mutation ● ValueSetDelete mutation ● VerificationResultDelete mutation ● VisionPrescriptionDelete mutation

Member Of

Account object ● AccountCoverage object ● AccountGuarantor object ● ActivityDefinition object ● AdministrableProductDefinition object ● AdverseEvent object ● AdverseEventCausality object ● AdverseEventSuspectEntity object ● AllergyIntolerance object ● Annotation object ● Appointment object ● AppointmentParticipant object ● AppointmentResponse object ● AuditEventAgent object ● AuditEventEntity object ● AuditEventSource object ● Basic object ● Binary object ● BiologicallyDerivedProduct object ● BiologicallyDerivedProductCollection object ● BiologicallyDerivedProductProcessing object ● BodyStructure object ● CarePlan object ● CarePlanActivity object ● CarePlanDetail object ● CareTeam object ● CareTeamParticipant object ● CatalogEntry object ● CatalogEntryRelatedEntry object ● ChargeItem object ● ChargeItemDefinition object ● ChargeItemPerformer object ● CitationPart object ● CitationPublishedIn object ● CitationRelatesTo object ● CitationRelatesTo1 object ● CitationVersion object ● CitationWhoClassified object ● Claim object ● ClaimAccident object ● ClaimCareTeam object ● ClaimDetail object ● ClaimDiagnosis object ● ClaimInsurance object ● ClaimItem object ● ClaimPayee object ● ClaimProcedure object ● ClaimRelated object ● ClaimResponse object ● ClaimResponseAddItem object ● ClaimResponseInsurance object ● ClaimSubDetail object ● ClaimSupportingInfo object ● ClinicalImpression object ● ClinicalImpressionFinding object ● ClinicalImpressionInvestigation object ● ClinicalUseDefinition object ● ClinicalUseDefinitionContraindication object ● ClinicalUseDefinitionIndication object ● ClinicalUseDefinitionInteractant object ● CodeableReference object ● Communication object ● CommunicationPayload object ● CommunicationRequest object ● CommunicationRequestPayload object ● Composition object ● CompositionAttester object ● CompositionEvent object ● CompositionRelatesTo object ● CompositionSection object ● Condition object ● ConditionEvidence object ● ConditionStage object ● Consent object ● ConsentActor object ● ConsentData object ● ConsentVerification object ● Contract object ● ContractAction object ● ContractAnswer object ● ContractAsset object ● ContractContentDefinition object ● ContractContext object ● ContractFriendly object ● ContractLegal object ● ContractOffer object ● ContractParty object ● ContractRule object ● ContractSigner object ● ContractSubject object ● ContractTerm object ● ContractValuedItem object ● Coverage object ● CoverageEligibilityRequest object ● CoverageEligibilityRequestDiagnosis object ● CoverageEligibilityRequestInsurance object ● CoverageEligibilityRequestItem object ● CoverageEligibilityRequestSupportingInfo object ● CoverageEligibilityResponse object ● CoverageEligibilityResponseInsurance object ● CoverageEligibilityResponseItem object ● DataRequirement object ● DetectedIssue object ● DetectedIssueEvidence object ● DetectedIssueMitigation object ● Device object ● DeviceDefinition object ● DeviceMetric object ● DeviceRequest object ● DeviceUseStatement object ● DiagnosticReport object ● DiagnosticReportMedia object ● DocumentManifest object ● DocumentManifestRelated object ● DocumentReference object ● DocumentReferenceContext object ● DocumentReferenceRelatesTo object ● ElementDefinition object ● ElementDefinitionExample object ● Encounter object ● EncounterDiagnosis object ● EncounterHospitalization object ● EncounterLocation object ● EncounterParticipant object ● Endpoint object ● EnrollmentRequest object ● EnrollmentResponse object ● EpisodeOfCare object ● EpisodeOfCareDiagnosis object ● EventDefinition object ● EvidenceReport object ● EvidenceReportCharacteristic object ● EvidenceReportRelatesTo object ● EvidenceReportSection object ● ExplanationOfBenefit object ● ExplanationOfBenefitAccident object ● ExplanationOfBenefitAddItem object ● ExplanationOfBenefitCareTeam object ● ExplanationOfBenefitDetail object ● ExplanationOfBenefitDiagnosis object ● ExplanationOfBenefitInsurance object ● ExplanationOfBenefitItem object ● ExplanationOfBenefitPayee object ● ExplanationOfBenefitProcedure object ● ExplanationOfBenefitRelated object ● ExplanationOfBenefitSubDetail object ● ExplanationOfBenefitSupportingInfo object ● Extension object ● FamilyMemberHistory object ● Flag object ● Goal object ● Group object ● GroupCharacteristic object ● GroupMember object ● GuidanceResponse object ● HealthcareService object ● Identifier object ● ImagingStudy object ● ImagingStudyPerformer object ● ImagingStudySeries object ● Immunization object ● ImmunizationEvaluation object ● ImmunizationPerformer object ● ImmunizationProtocolApplied object ● ImmunizationReaction object ● ImmunizationRecommendation object ● ImmunizationRecommendationRecommendation object ● ImplementationGuidePage object ● ImplementationGuideResource object ● ImplementationGuideResource1 object ● Ingredient object ● IngredientManufacturer object ● InsurancePlan object ● InsurancePlanCoverage object ● InsurancePlanPlan object ● Invoice object ● InvoiceLineItem object ● InvoiceParticipant object ● Library object ● Linkage object ● LinkageItem object ● List object ● ListEntry object ● Location object ● ManufacturedItemDefinition object ● Measure object ● MeasureReport object ● MeasureReportPopulation object ● MeasureReportPopulation1 object ● Media object ● Medication object ● MedicationAdministration object ● MedicationAdministrationPerformer object ● MedicationDispense object ● MedicationDispensePerformer object ● MedicationDispenseSubstitution object ● MedicationIngredient object ● MedicationKnowledge object ● MedicationKnowledgeAdministrationGuidelines object ● MedicationKnowledgeIngredient object ● MedicationKnowledgeMonograph object ● MedicationKnowledgeRegulatory object ● MedicationKnowledgeRelatedMedicationKnowledge object ● MedicationRequest object ● MedicationRequestDispenseRequest object ● MedicationStatement object ● MedicinalProductDefinition object ● MedicinalProductDefinitionContact object ● MedicinalProductDefinitionOperation object ● MessageHeader object ● MessageHeaderDestination object ● MessageHeaderResponse object ● MolecularSequence object ● MolecularSequenceReferenceSeq object ● MolecularSequenceVariant object ● NutritionOrder object ● NutritionProduct object ● Observation object ● ObservationDefinition object ● Organization object ● OrganizationAffiliation object ● PackagedProductDefinition object ● PackagedProductDefinitionPackage object ● Patient object ● PatientContact object ● PatientLink object ● PaymentNotice object ● PaymentReconciliation object ● PaymentReconciliationDetail object ● Person object ● PersonLink object ● PlanDefinition object ● PlanDefinitionAction object ● PractitionerQualification object ● PractitionerRole object ● Procedure object ● ProcedureFocalDevice object ● ProcedurePerformer object ● Provenance object ● ProvenanceAgent object ● ProvenanceEntity object ● QuestionnaireAnswerOption object ● QuestionnaireEnableWhen object ● QuestionnaireInitial object ● QuestionnaireResponse object ● QuestionnaireResponseAnswer object ● RegulatedAuthorization object ● RelatedPerson object ● RequestGroup object ● RequestGroupAction object ● ResearchDefinition object ● ResearchElementDefinition object ● ResearchStudy object ● ResearchSubject object ● RiskAssessment object ● Schedule object ● ServiceRequest object ● Signature object ● Slot object ● Specimen object ● SpecimenCollection object ● SpecimenContainer object ● SpecimenDefinitionAdditive object ● SpecimenProcessing object ● StructureMapSource object ● SubscriptionStatus object ● SubscriptionStatusNotificationEvent object ● SubstanceDefinition object ● SubstanceDefinitionCode object ● SubstanceDefinitionName object ● SubstanceDefinitionRelationship object ● SubstanceDefinitionRepresentation object ● SubstanceDefinitionStructure object ● SubstanceIngredient object ● SupplyDelivery object ● SupplyDeliverySuppliedItem object ● SupplyRequest object ● Task object ● TaskInput object ● TaskOutput object ● TaskRestriction object ● TestReport object ● TestScript object ● TestScriptFixture object ● TriggerDefinition object ● UsageContext object ● VerificationResult object ● VerificationResultAttestation object ● VerificationResultPrimarySource object ● VerificationResultValidator object ● VisionPrescription object