Package org.hl7.fhir.r5.model

Class DocumentReference

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.DocumentReference
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
public class DocumentReference extends DomainResource
A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this "document" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.
See Also:

  • Field Details

    • identifier

      protected List<Identifier> identifier
      Other business identifiers associated with the document, including version independent identifiers.

    • basedOn

      protected List<Reference> basedOn
      A procedure that is fulfilled in whole or in part by the creation of this media.

    • status

      protected Enumeration<Enumerations.DocumentReferenceStatus> status
      The status of this document reference.

    • docStatus

      protected Enumeration<Enumerations.CompositionStatus> docStatus
      The status of the underlying document.

    • type

      protected CodeableConcept type
      Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

    • category

      protected List<CodeableConcept> category
      A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

    • subject

      protected Reference subject
      Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

    • context

      protected List<Reference> context
      Describes the clinical encounter or type of care that the document content is associated with.

    • event

      protected List<CodeableReference> event
      This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

    • facilityType

      protected CodeableConcept facilityType
      The kind of facility where the patient was seen.

    • practiceSetting

      protected CodeableConcept practiceSetting
      This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

    • period

      protected Period period
      The time period over which the service that is described by the document was provided.

    • date

      protected InstantType date
      When the document reference was created.

    • author

      protected List<Reference> author
      Identifies who is responsible for adding the information to the document.

    • attester

      protected List<DocumentReference.DocumentReferenceAttesterComponent> attester
      A participant who has authenticated the accuracy of the document.

    • custodian

      protected Reference custodian
      Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

    • relatesTo

      protected List<DocumentReference.DocumentReferenceRelatesToComponent> relatesTo
      Relationships that this document has with other document references that already exist.

    • description

      protected MarkdownType description
      Human-readable description of the source document.

    • securityLabel

      protected List<CodeableConcept> securityLabel
      A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.

    • content

      protected List<DocumentReference.DocumentReferenceContentComponent> content
      The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.

    • SP_ATTESTER

      public static final String SP_ATTESTER
      Search parameter: attester

      Description: Who attested the document
      Type: reference
      Path: DocumentReference.attester.party

      See Also:

    • ATTESTER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ATTESTER
      Fluent Client search parameter constant for attester

      Description: Who attested the document
      Type: reference
      Path: DocumentReference.attester.party

    • INCLUDE_ATTESTER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ATTESTER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:attester".

    • SP_AUTHOR

      public static final String SP_AUTHOR
      Search parameter: author

      Description: Who and/or what authored the document
      Type: reference
      Path: DocumentReference.author

      See Also:

    • AUTHOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR
      Fluent Client search parameter constant for author

      Description: Who and/or what authored the document
      Type: reference
      Path: DocumentReference.author

    • INCLUDE_AUTHOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:author".

    • SP_BASED_ON

      public static final String SP_BASED_ON
      Search parameter: based-on

      Description: Procedure that caused this media to be created
      Type: reference
      Path: DocumentReference.basedOn

      See Also:

    • BASED_ON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
      Fluent Client search parameter constant for based-on

      Description: Procedure that caused this media to be created
      Type: reference
      Path: DocumentReference.basedOn

    • INCLUDE_BASED_ON

      public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:based-on".

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter: category

      Description: Categorization of document
      Type: token
      Path: DocumentReference.category

      See Also:

    • CATEGORY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
      Fluent Client search parameter constant for category

      Description: Categorization of document
      Type: token
      Path: DocumentReference.category

    • SP_CONTENTTYPE

      public static final String SP_CONTENTTYPE
      Search parameter: contenttype

      Description: Mime type of the content, with charset etc.
      Type: token
      Path: DocumentReference.content.attachment.contentType

      See Also:

    • CONTENTTYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTENTTYPE
      Fluent Client search parameter constant for contenttype

      Description: Mime type of the content, with charset etc.
      Type: token
      Path: DocumentReference.content.attachment.contentType

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: Context of the document content
      Type: reference
      Path: DocumentReference.context

      See Also:

    • CONTEXT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT
      Fluent Client search parameter constant for context

      Description: Context of the document content
      Type: reference
      Path: DocumentReference.context

    • INCLUDE_CONTEXT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:context".

    • SP_CREATION

      public static final String SP_CREATION
      Search parameter: creation

      Description: Date attachment was first created
      Type: date
      Path: DocumentReference.content.attachment.creation

      See Also:

    • CREATION

      public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATION
      Fluent Client search parameter constant for creation

      Description: Date attachment was first created
      Type: date
      Path: DocumentReference.content.attachment.creation

    • SP_CUSTODIAN

      public static final String SP_CUSTODIAN
      Search parameter: custodian

      Description: Organization which maintains the document
      Type: reference
      Path: DocumentReference.custodian

      See Also:

    • CUSTODIAN

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CUSTODIAN
      Fluent Client search parameter constant for custodian

      Description: Organization which maintains the document
      Type: reference
      Path: DocumentReference.custodian

    • INCLUDE_CUSTODIAN

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CUSTODIAN
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:custodian".

    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: When this document reference was created
      Type: date
      Path: DocumentReference.date

      See Also:

    • DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

      Description: When this document reference was created
      Type: date
      Path: DocumentReference.date

    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: Human-readable description
      Type: string
      Path: DocumentReference.description

      See Also:

    • DESCRIPTION

      public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
      Fluent Client search parameter constant for description

      Description: Human-readable description
      Type: string
      Path: DocumentReference.description

    • SP_DOC_STATUS

      public static final String SP_DOC_STATUS
      Search parameter: doc-status

      Description: preliminary | final | amended | entered-in-error
      Type: token
      Path: DocumentReference.docStatus

      See Also:

    • DOC_STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam DOC_STATUS
      Fluent Client search parameter constant for doc-status

      Description: preliminary | final | amended | entered-in-error
      Type: token
      Path: DocumentReference.docStatus

    • SP_EVENT_CODE

      public static final String SP_EVENT_CODE
      Search parameter: event-code

      Description: Main clinical acts documented
      Type: token
      Path: DocumentReference.event.concept

      See Also:

    • EVENT_CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam EVENT_CODE
      Fluent Client search parameter constant for event-code

      Description: Main clinical acts documented
      Type: token
      Path: DocumentReference.event.concept

    • SP_EVENT_REFERENCE

      public static final String SP_EVENT_REFERENCE
      Search parameter: event-reference

      Description: Main clinical acts documented
      Type: reference
      Path: DocumentReference.event.reference

      See Also:

    • EVENT_REFERENCE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam EVENT_REFERENCE
      Fluent Client search parameter constant for event-reference

      Description: Main clinical acts documented
      Type: reference
      Path: DocumentReference.event.reference

    • INCLUDE_EVENT_REFERENCE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_EVENT_REFERENCE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:event-reference".

    • SP_FACILITY

      public static final String SP_FACILITY
      Search parameter: facility

      Description: Kind of facility where patient was seen
      Type: token
      Path: DocumentReference.facilityType

      See Also:

    • FACILITY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam FACILITY
      Fluent Client search parameter constant for facility

      Description: Kind of facility where patient was seen
      Type: token
      Path: DocumentReference.facilityType

    • SP_FORMAT_CANONICAL

      public static final String SP_FORMAT_CANONICAL
      Search parameter: format-canonical

      Description: Profile canonical content rules for the document
      Type: reference
      Path: (DocumentReference.content.profile.value as canonical)

      See Also:

    • FORMAT_CANONICAL

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FORMAT_CANONICAL
      Fluent Client search parameter constant for format-canonical

      Description: Profile canonical content rules for the document
      Type: reference
      Path: (DocumentReference.content.profile.value as canonical)

    • INCLUDE_FORMAT_CANONICAL

      public static final ca.uhn.fhir.model.api.Include INCLUDE_FORMAT_CANONICAL
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:format-canonical".

    • SP_FORMAT_CODE

      public static final String SP_FORMAT_CODE
      Search parameter: format-code

      Description: Format code content rules for the document
      Type: token
      Path: (DocumentReference.content.profile.value as Coding)

      See Also:

    • FORMAT_CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam FORMAT_CODE
      Fluent Client search parameter constant for format-code

      Description: Format code content rules for the document
      Type: token
      Path: (DocumentReference.content.profile.value as Coding)

    • SP_FORMAT_URI

      public static final String SP_FORMAT_URI
      Search parameter: format-uri

      Description: Profile URI content rules for the document
      Type: uri
      Path: (DocumentReference.content.profile.value as uri)

      See Also:

    • FORMAT_URI

      public static final ca.uhn.fhir.rest.gclient.UriClientParam FORMAT_URI
      Fluent Client search parameter constant for format-uri

      Description: Profile URI content rules for the document
      Type: uri
      Path: (DocumentReference.content.profile.value as uri)

    • SP_LANGUAGE

      public static final String SP_LANGUAGE
      Search parameter: language

      Description: Human language of the content (BCP-47)
      Type: token
      Path: DocumentReference.content.attachment.language

      See Also:

    • LANGUAGE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam LANGUAGE
      Fluent Client search parameter constant for language

      Description: Human language of the content (BCP-47)
      Type: token
      Path: DocumentReference.content.attachment.language

    • SP_LOCATION

      public static final String SP_LOCATION
      Search parameter: location

      Description: Uri where the data can be found
      Type: uri
      Path: DocumentReference.content.attachment.url

      See Also:

    • LOCATION

      public static final ca.uhn.fhir.rest.gclient.UriClientParam LOCATION
      Fluent Client search parameter constant for location

      Description: Uri where the data can be found
      Type: uri
      Path: DocumentReference.content.attachment.url

    • SP_PERIOD

      public static final String SP_PERIOD
      Search parameter: period

      Description: Time of service that is being documented
      Type: date
      Path: DocumentReference.period

      See Also:

    • PERIOD

      public static final ca.uhn.fhir.rest.gclient.DateClientParam PERIOD
      Fluent Client search parameter constant for period

      Description: Time of service that is being documented
      Type: date
      Path: DocumentReference.period

    • SP_RELATESTO

      public static final String SP_RELATESTO
      Search parameter: relatesto

      Description: Target of the relationship
      Type: reference
      Path: DocumentReference.relatesTo.target

      See Also:

    • RELATESTO

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATESTO
      Fluent Client search parameter constant for relatesto

      Description: Target of the relationship
      Type: reference
      Path: DocumentReference.relatesTo.target

    • INCLUDE_RELATESTO

      public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATESTO
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:relatesto".

    • SP_RELATION

      public static final String SP_RELATION
      Search parameter: relation

      Description: replaces | transforms | signs | appends
      Type: token
      Path: DocumentReference.relatesTo.code

      See Also:

    • RELATION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATION
      Fluent Client search parameter constant for relation

      Description: replaces | transforms | signs | appends
      Type: token
      Path: DocumentReference.relatesTo.code

    • SP_RELATIONSHIP

      public static final String SP_RELATIONSHIP
      Search parameter: relationship

      Description: Combination of relation and relatesTo
      Type: composite
      Path: DocumentReference.relatesTo

      See Also:

    • RELATIONSHIP

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.ReferenceClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> RELATIONSHIP
      Fluent Client search parameter constant for relationship

      Description: Combination of relation and relatesTo
      Type: composite
      Path: DocumentReference.relatesTo

    • SP_SECURITY_LABEL

      public static final String SP_SECURITY_LABEL
      Search parameter: security-label

      Description: Document security-tags
      Type: token
      Path: DocumentReference.securityLabel

      See Also:

    • SECURITY_LABEL

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam SECURITY_LABEL
      Fluent Client search parameter constant for security-label

      Description: Document security-tags
      Type: token
      Path: DocumentReference.securityLabel

    • SP_SETTING

      public static final String SP_SETTING
      Search parameter: setting

      Description: Additional details about where the content was created (e.g. clinical specialty)
      Type: token
      Path: DocumentReference.practiceSetting

      See Also:

    • SETTING

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam SETTING
      Fluent Client search parameter constant for setting

      Description: Additional details about where the content was created (e.g. clinical specialty)
      Type: token
      Path: DocumentReference.practiceSetting

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: current | superseded | entered-in-error
      Type: token
      Path: DocumentReference.status

      See Also:

    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: current | superseded | entered-in-error
      Type: token
      Path: DocumentReference.status

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Who/what is the subject of the document
      Type: reference
      Path: DocumentReference.subject

      See Also:

    • SUBJECT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
      Fluent Client search parameter constant for subject

      Description: Who/what is the subject of the document
      Type: reference
      Path: DocumentReference.subject

    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:subject".

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
      Type: token
      Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier

      See Also:

    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
      Type: token
      Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
      Type: reference
      Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.subject | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | VisionPrescription.patient

      See Also:

    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
      Type: reference
      Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.subject | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | VisionPrescription.patient

    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:patient".

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [DocumentManifest](documentmanifest.html): Kind of document set [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management
      Type: token
      Path: AllergyIntolerance.type | Composition.type | DocumentManifest.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type

      See Also:

    • TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
      Fluent Client search parameter constant for type

      Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [DocumentManifest](documentmanifest.html): Kind of document set [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management
      Type: token
      Path: AllergyIntolerance.type | Composition.type | DocumentManifest.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type

  • Constructor Details

  • Method Details