Package ca.uhn.fhir.model.dstu2.resource

Class DiagnosticOrder

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.DiagnosticOrder
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
public class DiagnosticOrder extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR DiagnosticOrder Resource (clinical.diagnostics)

Definition: A record of a request for a diagnostic investigation service to be performed.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/DiagnosticOrder

See Also:

  • Field Details

    • SP_ACTOR

      public static final String SP_ACTOR
      Search parameter constant for actor

      Description:
      Type: reference
      Path: DiagnosticOrder.event.actor | DiagnosticOrder.item.event.actor

      See Also:

    • ACTOR

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

      Description:
      Type: reference
      Path: DiagnosticOrder.event.actor | DiagnosticOrder.item.event.actor

    • SP_BODYSITE

      public static final String SP_BODYSITE
      Search parameter constant for bodysite

      Description:
      Type: token
      Path: DiagnosticOrder.item.bodySite

      See Also:

    • BODYSITE

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

      Description:
      Type: token
      Path: DiagnosticOrder.item.bodySite

    • SP_CODE

      public static final String SP_CODE
      Search parameter constant for code

      Description:
      Type: token
      Path: DiagnosticOrder.item.code

      See Also:

    • CODE

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

      Description:
      Type: token
      Path: DiagnosticOrder.item.code

    • SP_EVENT_DATE

      public static final String SP_EVENT_DATE
      Search parameter constant for event-date

      Description:
      Type: date
      Path: DiagnosticOrder.event.dateTime

      See Also:

    • EVENT_DATE

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

      Description:
      Type: date
      Path: DiagnosticOrder.event.dateTime

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter constant for encounter

      Description:
      Type: reference
      Path: DiagnosticOrder.encounter

      See Also:

    • ENCOUNTER

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

      Description:
      Type: reference
      Path: DiagnosticOrder.encounter

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description:
      Type: token
      Path: DiagnosticOrder.identifier

      See Also:

    • IDENTIFIER

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

      Description:
      Type: token
      Path: DiagnosticOrder.identifier

    • SP_ITEM_DATE

      public static final String SP_ITEM_DATE
      Search parameter constant for item-date

      Description:
      Type: date
      Path: DiagnosticOrder.item.event.dateTime

      See Also:

    • ITEM_DATE

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

      Description:
      Type: date
      Path: DiagnosticOrder.item.event.dateTime

    • SP_ITEM_PAST_STATUS

      public static final String SP_ITEM_PAST_STATUS
      Search parameter constant for item-past-status

      Description:
      Type: token
      Path: DiagnosticOrder.item.event.status

      See Also:

    • 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:
      Type: token
      Path: DiagnosticOrder.item.event.status

    • SP_ITEM_STATUS

      public static final String SP_ITEM_STATUS
      Search parameter constant for item-status

      Description:
      Type: token
      Path: DiagnosticOrder.item.status

      See Also:

    • ITEM_STATUS

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

      Description:
      Type: token
      Path: DiagnosticOrder.item.status

    • SP_ORDERER

      public static final String SP_ORDERER
      Search parameter constant for orderer

      Description:
      Type: reference
      Path: DiagnosticOrder.orderer

      See Also:

    • ORDERER

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

      Description:
      Type: reference
      Path: DiagnosticOrder.orderer

    • SP_EVENT_STATUS

      public static final String SP_EVENT_STATUS
      Search parameter constant for event-status

      Description:
      Type: token
      Path: DiagnosticOrder.event.status

      See Also:

    • EVENT_STATUS

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

      Description:
      Type: token
      Path: DiagnosticOrder.event.status

    • SP_SPECIMEN

      public static final String SP_SPECIMEN
      Search parameter constant for specimen

      Description:
      Type: reference
      Path: DiagnosticOrder.specimen | DiagnosticOrder.item.specimen

      See Also:

    • SPECIMEN

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

      Description:
      Type: reference
      Path: DiagnosticOrder.specimen | DiagnosticOrder.item.specimen

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter constant for status

      Description:
      Type: token
      Path: DiagnosticOrder.status

      See Also:

    • STATUS

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

      Description:
      Type: token
      Path: DiagnosticOrder.status

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter constant for subject

      Description:
      Type: reference
      Path: DiagnosticOrder.subject

      See Also:

    • SUBJECT

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

      Description:
      Type: reference
      Path: DiagnosticOrder.subject

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter constant for patient

      Description:
      Type: reference
      Path: DiagnosticOrder.subject

      See Also:

    • PATIENT

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

      Description:
      Type: reference
      Path: DiagnosticOrder.subject

    • SP_ITEM_PAST_STATUS_ITEM_DATE

      public static final String SP_ITEM_PAST_STATUS_ITEM_DATE
      Search parameter constant for item-past-status-item-date

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

      See Also:

    • ITEM_PAST_STATUS_ITEM_DATE

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

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

    • SP_EVENT_STATUS_EVENT_DATE

      public static final String SP_EVENT_STATUS_EVENT_DATE
      Search parameter constant for event-status-event-date

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

      See Also:

    • EVENT_STATUS_EVENT_DATE

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

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

    • 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".

    • 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".

    • 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".

    • 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".

    • 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".

    • 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".

  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase

    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

    • getSubject

      public ResourceReferenceDt getSubject()
      Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.

      Definition: Who or what the investigation is to be performed on. 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)

    • setSubject

      public DiagnosticOrder setSubject(ResourceReferenceDt theValue)
      Sets the value(s) for subject (who.focus)

      Definition: Who or what the investigation is to be performed on. 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)

    • getOrderer

      public ResourceReferenceDt getOrderer()
      Gets the value(s) for orderer (who.actor). creating it if it does not exist. Will not return null.

      Definition: The practitioner that holds legal responsibility for ordering the investigation

    • setOrderer

      public DiagnosticOrder setOrderer(ResourceReferenceDt theValue)
      Sets the value(s) for orderer (who.actor)

      Definition: The practitioner that holds legal responsibility for ordering the investigation

    • getIdentifier

      public List<IdentifierDt> getIdentifier()
      Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

      Definition: Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

    • setIdentifier

      public DiagnosticOrder setIdentifier(List<IdentifierDt> theValue)
      Sets the value(s) for identifier (id)

      Definition: Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

    • addIdentifier

      public IdentifierDt addIdentifier()
      Adds and returns a new value for identifier (id)

      Definition: Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

    • addIdentifier

      public DiagnosticOrder addIdentifier(IdentifierDt theValue)
      Adds a given new value for identifier (id)

      Definition: Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

      Parameters:
      theValue - The identifier to add (must not be null)

    • getIdentifierFirstRep

      public IdentifierDt getIdentifierFirstRep()
      Gets the first repetition for identifier (id), creating it if it does not already exist.

      Definition: Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

    • getEncounter

      public ResourceReferenceDt getEncounter()
      Gets the value(s) for encounter (context). creating it if it does not exist. Will not return null.

      Definition: An encounter that provides additional information about the healthcare context in which this request is made

    • setEncounter

      public DiagnosticOrder setEncounter(ResourceReferenceDt theValue)
      Sets the value(s) for encounter (context)

      Definition: An encounter that provides additional information about the healthcare context in which this request is made

    • getReason

      public List<CodeableConceptDt> getReason()
      Gets the value(s) for reason (). creating it if it does not exist. Will not return null.

      Definition: 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.

    • setReason

      public DiagnosticOrder setReason(List<CodeableConceptDt> theValue)
      Sets the value(s) for reason ()

      Definition: 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.

    • addReason

      public CodeableConceptDt addReason()
      Adds and returns a new value for reason ()

      Definition: 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.

    • addReason

      public DiagnosticOrder addReason(CodeableConceptDt theValue)
      Adds a given new value for reason ()

      Definition: 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.

      Parameters:
      theValue - The reason to add (must not be null)

    • getReasonFirstRep

      public CodeableConceptDt getReasonFirstRep()
      Gets the first repetition for reason (), creating it if it does not already exist.

      Definition: 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.

    • getSupportingInformation

      public List<ResourceReferenceDt> getSupportingInformation()
      Gets the value(s) for supportingInformation (). creating it if it does not exist. Will not return null.

      Definition: 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.

    • setSupportingInformation

      public DiagnosticOrder setSupportingInformation(List<ResourceReferenceDt> theValue)
      Sets the value(s) for supportingInformation ()

      Definition: 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.

    • addSupportingInformation

      public ResourceReferenceDt addSupportingInformation()
      Adds and returns a new value for supportingInformation ()

      Definition: 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.

    • getSpecimen

      public List<ResourceReferenceDt> getSpecimen()
      Gets the value(s) for specimen (). creating it if it does not exist. Will not return null.

      Definition: One or more specimens that the diagnostic investigation is about

    • setSpecimen

      public DiagnosticOrder setSpecimen(List<ResourceReferenceDt> theValue)
      Sets the value(s) for specimen ()

      Definition: One or more specimens that the diagnostic investigation is about

    • addSpecimen

      public ResourceReferenceDt addSpecimen()
      Adds and returns a new value for specimen ()

      Definition: One or more specimens that the diagnostic investigation is about

    • getStatusElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<DiagnosticOrderStatusEnum> getStatusElement()
      Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

      Definition: The status of the order

    • getStatus

      public String getStatus()
      Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

      Definition: The status of the order

    • setStatus

      public DiagnosticOrder setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<DiagnosticOrderStatusEnum> theValue)
      Sets the value(s) for status (status)

      Definition: The status of the order

    • setStatus

      public DiagnosticOrder setStatus(DiagnosticOrderStatusEnum theValue)
      Sets the value(s) for status (status)

      Definition: The status of the order

    • getPriorityElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<DiagnosticOrderPriorityEnum> getPriorityElement()
      Gets the value(s) for priority (grade). creating it if it does not exist. Will not return null.

      Definition: The clinical priority associated with this order

    • getPriority

      public String getPriority()
      Gets the value(s) for priority (grade). creating it if it does not exist. This method may return null.

      Definition: The clinical priority associated with this order

    • setPriority

      public DiagnosticOrder setPriority(ca.uhn.fhir.model.primitive.BoundCodeDt<DiagnosticOrderPriorityEnum> theValue)
      Sets the value(s) for priority (grade)

      Definition: The clinical priority associated with this order

    • setPriority

      public DiagnosticOrder setPriority(DiagnosticOrderPriorityEnum theValue)
      Sets the value(s) for priority (grade)

      Definition: The clinical priority associated with this order

    • getEvent

      public List<DiagnosticOrder.Event> getEvent()
      Gets the value(s) for event (). creating it if it does not exist. Will not return null.

      Definition: A summary of the events of interest that have occurred as the request is processed; e.g. when the order was made, various processing steps (specimens received), when it was completed

    • setEvent

      public DiagnosticOrder setEvent(List<DiagnosticOrder.Event> theValue)
      Sets the value(s) for event ()

      Definition: A summary of the events of interest that have occurred as the request is processed; e.g. when the order was made, various processing steps (specimens received), when it was completed

    • addEvent

      public DiagnosticOrder.Event addEvent()
      Adds and returns a new value for event ()

      Definition: A summary of the events of interest that have occurred as the request is processed; e.g. when the order was made, various processing steps (specimens received), when it was completed

    • addEvent

      public DiagnosticOrder addEvent(DiagnosticOrder.Event theValue)
      Adds a given new value for event ()

      Definition: A summary of the events of interest that have occurred as the request is processed; e.g. when the order was made, various processing steps (specimens received), when it was completed

      Parameters:
      theValue - The event to add (must not be null)

    • getEventFirstRep

      public DiagnosticOrder.Event getEventFirstRep()
      Gets the first repetition for event (), creating it if it does not already exist.

      Definition: A summary of the events of interest that have occurred as the request is processed; e.g. when the order was made, various processing steps (specimens received), when it was completed

    • getItem

      public List<DiagnosticOrder.Item> getItem()
      Gets the value(s) for item (). creating it if it does not exist. Will not return null.

      Definition: 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

    • setItem

      public DiagnosticOrder setItem(List<DiagnosticOrder.Item> theValue)
      Sets the value(s) for item ()

      Definition: 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

    • addItem

      public DiagnosticOrder.Item addItem()
      Adds and returns a new value for item ()

      Definition: 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

    • addItem

      public DiagnosticOrder addItem(DiagnosticOrder.Item theValue)
      Adds a given new value for item ()

      Definition: 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

      Parameters:
      theValue - The item to add (must not be null)

    • getItemFirstRep

      public DiagnosticOrder.Item getItemFirstRep()
      Gets the first repetition for item (), creating it if it does not already exist.

      Definition: 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

    • getNote

      public List<AnnotationDt> getNote()
      Gets the value(s) for note (). creating it if it does not exist. Will not return null.

      Definition: Any other notes associated with this patient, specimen or order (e.g. \"patient hates needles\")

    • setNote

      public DiagnosticOrder setNote(List<AnnotationDt> theValue)
      Sets the value(s) for note ()

      Definition: Any other notes associated with this patient, specimen or order (e.g. \"patient hates needles\")

    • addNote

      public AnnotationDt addNote()
      Adds and returns a new value for note ()

      Definition: Any other notes associated with this patient, specimen or order (e.g. \"patient hates needles\")

    • addNote

      public DiagnosticOrder addNote(AnnotationDt theValue)
      Adds a given new value for note ()

      Definition: Any other notes associated with this patient, specimen or order (e.g. \"patient hates needles\")

      Parameters:
      theValue - The note to add (must not be null)

    • getNoteFirstRep

      public AnnotationDt getNoteFirstRep()
      Gets the first repetition for note (), creating it if it does not already exist.

      Definition: Any other notes associated with this patient, specimen or order (e.g. \"patient hates needles\")

    • getResourceName

      public String getResourceName()
      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource

    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource