Class DocumentManifest

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 DocumentManifest extends DomainResource
A collection of documents compiled for a purpose together with metadata that applies to the collection.
See Also:
Serialized Form
  • Field Details

    • masterIdentifier

      A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
    • identifier

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

      The status of this document manifest.
    • type

      protected CodeableConcept type
      Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.
    • subject

      protected Reference subject
      Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
    • subjectTarget

      The actual object that is the target of the reference (Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).)
    • created

      protected DateTimeType created
      When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
    • author

      protected List<Reference> author
      Identifies who is responsible for creating the manifest, and adding documents to it.
    • authorTarget

      The actual objects that are the target of the reference (Identifies who is responsible for creating the manifest, and adding documents to it.)
    • recipient

      protected List<Reference> recipient
      A patient, practitioner, or organization for which this set of documents is intended.
    • recipientTarget

      The actual objects that are the target of the reference (A patient, practitioner, or organization for which this set of documents is intended.)
    • source

      protected UriType source
      Identifies the source system, application, or software that produced the document manifest.
    • description

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

      The list of Documents included in the manifest.
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Unique Identifier for the set of documents
      Type: token
      Path: DocumentManifest.masterIdentifier, DocumentManifest.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: Unique Identifier for the set of documents
      Type: token
      Path: DocumentManifest.masterIdentifier, DocumentManifest.identifier

    • SP_CONTENT_REF

      public static final String SP_CONTENT_REF
      Search parameter: content-ref

      Description: Contents of this set of documents
      Type: reference
      Path: DocumentManifest.content.pReference

      See Also:
      Constant Field Values
    • CONTENT_REF

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTENT_REF
      Fluent Client search parameter constant for content-ref

      Description: Contents of this set of documents
      Type: reference
      Path: DocumentManifest.content.pReference

    • INCLUDE_CONTENT_REF

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTENT_REF
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:content-ref".
    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: The subject of the set of documents
      Type: reference
      Path: DocumentManifest.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: The subject of the set of documents
      Type: reference
      Path: DocumentManifest.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 "DocumentManifest:subject".
    • SP_AUTHOR

      public static final String SP_AUTHOR
      Search parameter: author

      Description: Who and/or what authored the manifest
      Type: reference
      Path: DocumentManifest.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 manifest
      Type: reference
      Path: DocumentManifest.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 "DocumentManifest:author".
    • SP_CREATED

      public static final String SP_CREATED
      Search parameter: created

      Description: When this document manifest created
      Type: date
      Path: DocumentManifest.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: When this document manifest created
      Type: date
      Path: DocumentManifest.created

    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: Human-readable description (title)
      Type: string
      Path: DocumentManifest.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: DocumentManifest.description

    • SP_SOURCE

      public static final String SP_SOURCE
      Search parameter: source

      Description: The source system/application/software
      Type: uri
      Path: DocumentManifest.source

      See Also:
      Constant Field Values
    • SOURCE

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

      Description: The source system/application/software
      Type: uri
      Path: DocumentManifest.source

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: Kind of document set
      Type: token
      Path: DocumentManifest.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 set
      Type: token
      Path: DocumentManifest.type

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: The subject of the set of documents
      Type: reference
      Path: DocumentManifest.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: The subject of the set of documents
      Type: reference
      Path: DocumentManifest.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 "DocumentManifest:patient".
    • SP_RECIPIENT

      public static final String SP_RECIPIENT
      Search parameter: recipient

      Description: Intended to get notified about this set of documents
      Type: reference
      Path: DocumentManifest.recipient

      See Also:
      Constant Field Values
    • RECIPIENT

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

      Description: Intended to get notified about this set of documents
      Type: reference
      Path: DocumentManifest.recipient

    • INCLUDE_RECIPIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_RECIPIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:recipient".
    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: current | superseded | entered-in-error
      Type: token
      Path: DocumentManifest.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: DocumentManifest.status

  • Constructor Details

  • Method Details