Class DiagnosticOrder

  • 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 DiagnosticOrder
    extends DomainResource
    A record of a request for a diagnostic investigation service to be performed.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
      • subject

        protected Reference subject
        On whom or what the investigation is to be performed. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (On whom or what the investigation is to be performed. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)
      • encounter

        protected Reference encounter
        An encounter that provides additional information about the healthcare context in which this request is made.
      • encounterTarget

        protected Encounter encounterTarget
        The actual object that is the target of the reference (An encounter that provides additional information about the healthcare context in which this request is made.)
      • orderer

        protected Reference orderer
        The practitioner that holds legal responsibility for ordering the investigation.
      • ordererTarget

        protected Practitioner ordererTarget
        The actual object that is the target of the reference (The practitioner that holds legal responsibility for ordering the investigation.)
      • reason

        protected List<CodeableConcept> reason
        An explanation or justification for why this diagnostic investigation is being requested. This is often for billing purposes. May relate to the resources referred to in supportingInformation.
      • supportingInformation

        protected List<Reference> supportingInformation
        Additional clinical information about the patient or specimen that may influence test interpretations. This includes observations explicitly requested by the producer(filler) to provide context or supporting information needed to complete the order.
      • supportingInformationTarget

        protected List<Resource> supportingInformationTarget
        The actual objects that are the target of the reference (Additional clinical information about the patient or specimen that may influence test interpretations. This includes observations explicitly requested by the producer(filler) to provide context or supporting information needed to complete the order.)
      • specimen

        protected List<Reference> specimen
        One or more specimens that the diagnostic investigation is about.
      • specimenTarget

        protected List<Specimen> specimenTarget
        The actual objects that are the target of the reference (One or more specimens that the diagnostic investigation is about.)
      • item

        protected List<DiagnosticOrder.DiagnosticOrderItemComponent> item
        The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.
      • note

        protected List<Annotation> note
        Any other notes associated with this patient, specimen or order (e.g. "patient hates needles").
      • SP_ORDERER

        public static final String SP_ORDERER
        Search parameter: orderer

        Description: Who ordered the test
        Type: reference
        Path: DiagnosticOrder.orderer

        See Also:
        Constant Field Values
      • ORDERER

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

        Description: Who ordered the test
        Type: reference
        Path: DiagnosticOrder.orderer

      • INCLUDE_ORDERER

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

        public static final String SP_STATUS
        Search parameter: status

        Description: proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
        Type: token
        Path: DiagnosticOrder.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: proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
        Type: token
        Path: DiagnosticOrder.status

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: Who and/or what test is about
        Type: reference
        Path: DiagnosticOrder.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 and/or what test is about
        Type: reference
        Path: DiagnosticOrder.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 "DiagnosticOrder:subject".
      • SP_ITEM_STATUS

        public static final String SP_ITEM_STATUS
        Search parameter: item-status

        Description: proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
        Type: token
        Path: DiagnosticOrder.item.status

        See Also:
        Constant Field Values
      • ITEM_STATUS

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

        Description: proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
        Type: token
        Path: DiagnosticOrder.item.status

      • SP_EVENT_STATUS

        public static final String SP_EVENT_STATUS
        Search parameter: event-status

        Description: proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
        Type: token
        Path: DiagnosticOrder.event.status

        See Also:
        Constant Field Values
      • EVENT_STATUS

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

        Description: proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
        Type: token
        Path: DiagnosticOrder.event.status

      • SP_ACTOR

        public static final String SP_ACTOR
        Search parameter: actor

        Description: Who recorded or did this
        Type: reference
        Path: DiagnosticOrder.event.actor, DiagnosticOrder.item.event.actor

        See Also:
        Constant Field Values
      • ACTOR

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

        Description: Who recorded or did this
        Type: reference
        Path: DiagnosticOrder.event.actor, DiagnosticOrder.item.event.actor

      • INCLUDE_ACTOR

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ACTOR
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DiagnosticOrder:actor".
      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: Code to indicate the item (test or panel) being ordered
        Type: token
        Path: DiagnosticOrder.item.code

        See Also:
        Constant Field Values
      • CODE

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

        Description: Code to indicate the item (test or panel) being ordered
        Type: token
        Path: DiagnosticOrder.item.code

      • SP_ENCOUNTER

        public static final String SP_ENCOUNTER
        Search parameter: encounter

        Description: The encounter that this diagnostic order is associated with
        Type: reference
        Path: DiagnosticOrder.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: The encounter that this diagnostic order is associated with
        Type: reference
        Path: DiagnosticOrder.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 "DiagnosticOrder:encounter".
      • SP_ITEM_PAST_STATUS

        public static final String SP_ITEM_PAST_STATUS
        Search parameter: item-past-status

        Description: proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
        Type: token
        Path: DiagnosticOrder.item.event.status

        See Also:
        Constant Field Values
      • ITEM_PAST_STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ITEM_PAST_STATUS
        Fluent Client search parameter constant for item-past-status

        Description: proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
        Type: token
        Path: DiagnosticOrder.item.event.status

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Who and/or what test is about
        Type: reference
        Path: DiagnosticOrder.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 and/or what test is about
        Type: reference
        Path: DiagnosticOrder.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 "DiagnosticOrder:patient".
      • SP_BODYSITE

        public static final String SP_BODYSITE
        Search parameter: bodysite

        Description: Location of requested test (if applicable)
        Type: token
        Path: DiagnosticOrder.item.bodySite

        See Also:
        Constant Field Values
      • BODYSITE

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

        Description: Location of requested test (if applicable)
        Type: token
        Path: DiagnosticOrder.item.bodySite

      • SP_ITEM_DATE

        public static final String SP_ITEM_DATE
        Search parameter: item-date

        Description: The date at which the event happened
        Type: date
        Path: DiagnosticOrder.item.event.dateTime

        See Also:
        Constant Field Values
      • ITEM_DATE

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

        Description: The date at which the event happened
        Type: date
        Path: DiagnosticOrder.item.event.dateTime

      • SP_SPECIMEN

        public static final String SP_SPECIMEN
        Search parameter: specimen

        Description: If the whole order relates to specific specimens
        Type: reference
        Path: DiagnosticOrder.specimen, DiagnosticOrder.item.specimen

        See Also:
        Constant Field Values
      • SPECIMEN

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

        Description: If the whole order relates to specific specimens
        Type: reference
        Path: DiagnosticOrder.specimen, DiagnosticOrder.item.specimen

      • INCLUDE_SPECIMEN

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SPECIMEN
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DiagnosticOrder:specimen".
      • EVENT_STATUS_DATE

        public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.DateClientParam> EVENT_STATUS_DATE
        Fluent Client search parameter constant for event-status-date

        Description: A combination of past-status and date
        Type: composite
        Path:

      • SP_EVENT_DATE

        public static final String SP_EVENT_DATE
        Search parameter: event-date

        Description: The date at which the event happened
        Type: date
        Path: DiagnosticOrder.event.dateTime

        See Also:
        Constant Field Values
      • EVENT_DATE

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

        Description: The date at which the event happened
        Type: date
        Path: DiagnosticOrder.event.dateTime

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Identifiers assigned to this order
        Type: token
        Path: DiagnosticOrder.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: Identifiers assigned to this order
        Type: token
        Path: DiagnosticOrder.identifier

      • ITEM_STATUS_DATE

        public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.DateClientParam> ITEM_STATUS_DATE
        Fluent Client search parameter constant for item-status-date

        Description: A combination of item-past-status and item-date
        Type: composite
        Path: