Class 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.
See Also:
Serialized Form
  • Field Details

    • masterIdentifier

      Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
    • identifier

      Other identifiers associated with the document, including version independent identifiers.
    • status

      The status of this document reference.
    • 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.
    • class_

      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).
    • subjectTarget

      The actual object that is the target of the reference (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).)
    • created

      protected DateTimeType created
      When the document was created.
    • indexed

      protected InstantType indexed
      When the document reference was created.
    • author

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

      The actual objects that are the target of the reference (Identifies who is responsible for adding the information to the document.)
    • authenticator

      Which person or organization authenticates that this document is valid.
    • authenticatorTarget

      The actual object that is the target of the reference (Which person or organization authenticates that this document is valid.)
    • custodian

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

      The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)
    • relatesTo

      Relationships that this document has with other document references that already exist.
    • description

      Human-readable description of the source document. This is sometimes known as the "title".
    • securityLabel

      A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
    • content

      The document and format referenced. There may be multiple content element repetitions, each with a different format.
    • context

      The clinical context in which the document was prepared.
    • SP_SECURITYLABEL

      public static final String SP_SECURITYLABEL
      Search parameter: securitylabel

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

      See Also:
      Constant Field Values
    • SECURITYLABEL

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

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

    • 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:
      Constant Field Values
    • 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_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: Human-readable description (title)
      Type: string
      Path: DocumentReference.description

      See Also:
      Constant Field Values
    • DESCRIPTION

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

      Description: Human-readable description (title)
      Type: string
      Path: DocumentReference.description

    • 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:
      Constant Field Values
    • 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_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: Kind of document (LOINC if possible)
      Type: token
      Path: DocumentReference.type

      See Also:
      Constant Field Values
    • TYPE

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

      Description: Kind of document (LOINC if possible)
      Type: token
      Path: DocumentReference.type

    • SP_RELATION

      public static final String SP_RELATION
      Search parameter: relation

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

      See Also:
      Constant Field Values
    • 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_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.context.practiceSetting

      See Also:
      Constant Field Values
    • 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.context.practiceSetting

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

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

      See Also:
      Constant Field Values
    • PATIENT

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

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

    • 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_RELATIONSHIP

      public static final String SP_RELATIONSHIP
      Search parameter: relationship

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

      See Also:
      Constant Field Values
    • 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:

    • SP_EVENT

      public static final String SP_EVENT
      Search parameter: event

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

      See Also:
      Constant Field Values
    • EVENT

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

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

    • SP_CLASS

      public static final String SP_CLASS
      Search parameter: class

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

      See Also:
      Constant Field Values
    • CLASS

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

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

    • SP_AUTHENTICATOR

      public static final String SP_AUTHENTICATOR
      Search parameter: authenticator

      Description: Who/what authenticated the document
      Type: reference
      Path: DocumentReference.authenticator

      See Also:
      Constant Field Values
    • AUTHENTICATOR

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

      Description: Who/what authenticated the document
      Type: reference
      Path: DocumentReference.authenticator

    • INCLUDE_AUTHENTICATOR

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

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Master Version Specific Identifier
      Type: token
      Path: DocumentReference.masterIdentifier, DocumentReference.identifier

      See Also:
      Constant Field Values
    • IDENTIFIER

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

      Description: Master Version Specific Identifier
      Type: token
      Path: DocumentReference.masterIdentifier, DocumentReference.identifier

    • SP_PERIOD

      public static final String SP_PERIOD
      Search parameter: period

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

      See Also:
      Constant Field Values
    • 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.context.period

    • SP_CUSTODIAN

      public static final String SP_CUSTODIAN
      Search parameter: custodian

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

      See Also:
      Constant Field Values
    • 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_INDEXED

      public static final String SP_INDEXED
      Search parameter: indexed

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

      See Also:
      Constant Field Values
    • INDEXED

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

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

    • 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:
      Constant Field Values
    • 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_CREATED

      public static final String SP_CREATED
      Search parameter: created

      Description: Document creation time
      Type: date
      Path: DocumentReference.created

      See Also:
      Constant Field Values
    • CREATED

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

      Description: Document creation time
      Type: date
      Path: DocumentReference.created

    • SP_FORMAT

      public static final String SP_FORMAT
      Search parameter: format

      Description: Format/content rules for the document
      Type: token
      Path: DocumentReference.content.format

      See Also:
      Constant Field Values
    • FORMAT

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

      Description: Format/content rules for the document
      Type: token
      Path: DocumentReference.content.format

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

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

      See Also:
      Constant Field Values
    • ENCOUNTER

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

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

    • INCLUDE_ENCOUNTER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:encounter".
    • 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:
      Constant Field Values
    • 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_RELATESTO

      public static final String SP_RELATESTO
      Search parameter: relatesto

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

      See Also:
      Constant Field Values
    • 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_FACILITY

      public static final String SP_FACILITY
      Search parameter: facility

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

      See Also:
      Constant Field Values
    • 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.context.facilityType

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

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

      See Also:
      Constant Field Values
    • 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

  • Constructor Details

  • Method Details