package ca.uhn.fhir.model.dstu.resource;
/*
* #%L
* HAPI FHIR Library
* %%
* Copyright (C) 2014 University Health Network
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
import java.util.Date;
import java.util.List;
import ca.uhn.fhir.model.api.BaseElement;
import ca.uhn.fhir.model.api.BaseResource;
import ca.uhn.fhir.model.api.IDatatype;
import ca.uhn.fhir.model.api.IElement;
import ca.uhn.fhir.model.api.IResource;
import ca.uhn.fhir.model.api.IResourceBlock;
import ca.uhn.fhir.model.api.TemporalPrecisionEnum;
import ca.uhn.fhir.model.api.annotation.Block;
import ca.uhn.fhir.model.api.annotation.Child;
import ca.uhn.fhir.model.api.annotation.Description;
import ca.uhn.fhir.model.api.annotation.ResourceDef;
import ca.uhn.fhir.model.api.annotation.SearchParamDefinition;
import ca.uhn.fhir.model.dstu.composite.CodeableConceptDt;
import ca.uhn.fhir.model.dstu.composite.IdentifierDt;
import ca.uhn.fhir.model.dstu.composite.ResourceReferenceDt;
import ca.uhn.fhir.model.dstu.composite.ScheduleDt;
import ca.uhn.fhir.model.dstu.valueset.IdentifierUseEnum;
import ca.uhn.fhir.model.primitive.DateTimeDt;
import ca.uhn.fhir.rest.gclient.DateParam;
import ca.uhn.fhir.rest.gclient.Include;
import ca.uhn.fhir.rest.gclient.ReferenceParam;
import ca.uhn.fhir.rest.gclient.TokenParam;
/**
* HAPI/FHIR <b>Order</b> Resource
* (A request to perform an action)
*
* <p>
* <b>Definition:</b>
*
* </p>
*
* <p>
* <b>Requirements:</b>
*
* </p>
*
* <p>
* <b>Profile Definition:</b>
* <a href="http://hl7.org/fhir/profiles/Order">http://hl7.org/fhir/profiles/Order</a>
* </p>
*
*/
@ResourceDef(name="Order", profile="http://hl7.org/fhir/profiles/Order", id="order")
public class Order extends BaseResource implements IResource {
/**
* Search parameter constant for <b>date</b>
* <p>
* Description: <b></b><br/>
* Type: <b>date</b><br/>
* Path: <b>Order.date</b><br/>
* </p>
*/
@SearchParamDefinition(name="date", path="Order.date", description="")
public static final String SP_DATE = "date";
/**
* <b>Fluent Client</b> search parameter constant for <b>date</b>
* <p>
* Description: <b></b><br/>
* Type: <b>date</b><br/>
* Path: <b>Order.date</b><br/>
* </p>
*/
public static final DateParam DATE = new DateParam(SP_DATE);
/**
* Search parameter constant for <b>subject</b>
* <p>
* Description: <b></b><br/>
* Type: <b>reference</b><br/>
* Path: <b>Order.subject</b><br/>
* </p>
*/
@SearchParamDefinition(name="subject", path="Order.subject", description="")
public static final String SP_SUBJECT = "subject";
/**
* <b>Fluent Client</b> search parameter constant for <b>subject</b>
* <p>
* Description: <b></b><br/>
* Type: <b>reference</b><br/>
* Path: <b>Order.subject</b><br/>
* </p>
*/
public static final ReferenceParam SUBJECT = new ReferenceParam(SP_SUBJECT);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "<b>Order.subject</b>".
*/
public static final Include INCLUDE_SUBJECT = new Include("Order.subject");
/**
* Search parameter constant for <b>source</b>
* <p>
* Description: <b></b><br/>
* Type: <b>reference</b><br/>
* Path: <b>Order.source</b><br/>
* </p>
*/
@SearchParamDefinition(name="source", path="Order.source", description="")
public static final String SP_SOURCE = "source";
/**
* <b>Fluent Client</b> search parameter constant for <b>source</b>
* <p>
* Description: <b></b><br/>
* Type: <b>reference</b><br/>
* Path: <b>Order.source</b><br/>
* </p>
*/
public static final ReferenceParam SOURCE = new ReferenceParam(SP_SOURCE);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "<b>Order.source</b>".
*/
public static final Include INCLUDE_SOURCE = new Include("Order.source");
/**
* Search parameter constant for <b>target</b>
* <p>
* Description: <b></b><br/>
* Type: <b>reference</b><br/>
* Path: <b>Order.target</b><br/>
* </p>
*/
@SearchParamDefinition(name="target", path="Order.target", description="")
public static final String SP_TARGET = "target";
/**
* <b>Fluent Client</b> search parameter constant for <b>target</b>
* <p>
* Description: <b></b><br/>
* Type: <b>reference</b><br/>
* Path: <b>Order.target</b><br/>
* </p>
*/
public static final ReferenceParam TARGET = new ReferenceParam(SP_TARGET);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "<b>Order.target</b>".
*/
public static final Include INCLUDE_TARGET = new Include("Order.target");
/**
* Search parameter constant for <b>authority</b>
* <p>
* Description: <b></b><br/>
* Type: <b>reference</b><br/>
* Path: <b>Order.authority</b><br/>
* </p>
*/
@SearchParamDefinition(name="authority", path="Order.authority", description="")
public static final String SP_AUTHORITY = "authority";
/**
* <b>Fluent Client</b> search parameter constant for <b>authority</b>
* <p>
* Description: <b></b><br/>
* Type: <b>reference</b><br/>
* Path: <b>Order.authority</b><br/>
* </p>
*/
public static final ReferenceParam AUTHORITY = new ReferenceParam(SP_AUTHORITY);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "<b>Order.authority</b>".
*/
public static final Include INCLUDE_AUTHORITY = new Include("Order.authority");
/**
* Search parameter constant for <b>when_code</b>
* <p>
* Description: <b></b><br/>
* Type: <b>token</b><br/>
* Path: <b>Order.when.code</b><br/>
* </p>
*/
@SearchParamDefinition(name="when_code", path="Order.when.code", description="")
public static final String SP_WHEN_CODE = "when_code";
/**
* <b>Fluent Client</b> search parameter constant for <b>when_code</b>
* <p>
* Description: <b></b><br/>
* Type: <b>token</b><br/>
* Path: <b>Order.when.code</b><br/>
* </p>
*/
public static final TokenParam WHEN_CODE = new TokenParam(SP_WHEN_CODE);
/**
* Search parameter constant for <b>when</b>
* <p>
* Description: <b></b><br/>
* Type: <b>date</b><br/>
* Path: <b>Order.when.schedule</b><br/>
* </p>
*/
@SearchParamDefinition(name="when", path="Order.when.schedule", description="")
public static final String SP_WHEN = "when";
/**
* <b>Fluent Client</b> search parameter constant for <b>when</b>
* <p>
* Description: <b></b><br/>
* Type: <b>date</b><br/>
* Path: <b>Order.when.schedule</b><br/>
* </p>
*/
public static final DateParam WHEN = new DateParam(SP_WHEN);
/**
* Search parameter constant for <b>detail</b>
* <p>
* Description: <b></b><br/>
* Type: <b>reference</b><br/>
* Path: <b>Order.detail</b><br/>
* </p>
*/
@SearchParamDefinition(name="detail", path="Order.detail", description="")
public static final String SP_DETAIL = "detail";
/**
* <b>Fluent Client</b> search parameter constant for <b>detail</b>
* <p>
* Description: <b></b><br/>
* Type: <b>reference</b><br/>
* Path: <b>Order.detail</b><br/>
* </p>
*/
public static final ReferenceParam DETAIL = new ReferenceParam(SP_DETAIL);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "<b>Order.detail</b>".
*/
public static final Include INCLUDE_DETAIL = new Include("Order.detail");
@Child(name="identifier", type=IdentifierDt.class, order=0, min=0, max=Child.MAX_UNLIMITED)
@Description(
shortDefinition="Identifiers assigned to this order by the orderer or by the receiver",
formalDefinition=""
)
private java.util.List<IdentifierDt> myIdentifier;
@Child(name="date", type=DateTimeDt.class, order=1, min=0, max=1)
@Description(
shortDefinition="When the order was made",
formalDefinition=""
)
private DateTimeDt myDate;
@Child(name="subject", order=2, min=0, max=1, type={
ca.uhn.fhir.model.dstu.resource.Patient.class })
@Description(
shortDefinition="Patient this order is about",
formalDefinition=""
)
private ResourceReferenceDt mySubject;
@Child(name="source", order=3, min=0, max=1, type={
ca.uhn.fhir.model.dstu.resource.Practitioner.class })
@Description(
shortDefinition="Who initiated the order",
formalDefinition=""
)
private ResourceReferenceDt mySource;
@Child(name="target", order=4, min=0, max=1, type={
ca.uhn.fhir.model.dstu.resource.Organization.class, ca.uhn.fhir.model.dstu.resource.Device.class, ca.uhn.fhir.model.dstu.resource.Practitioner.class })
@Description(
shortDefinition="Who is intended to fulfill the order",
formalDefinition=""
)
private ResourceReferenceDt myTarget;
@Child(name="reason", order=5, min=0, max=1, type={
CodeableConceptDt.class, IResource.class })
@Description(
shortDefinition="Text - why the order was made",
formalDefinition=""
)
private IDatatype myReason;
@Child(name="authority", order=6, min=0, max=1, type={
IResource.class })
@Description(
shortDefinition="If required by policy",
formalDefinition=""
)
private ResourceReferenceDt myAuthority;
@Child(name="when", order=7, min=0, max=1)
@Description(
shortDefinition="When order should be fulfilled",
formalDefinition=""
)
private When myWhen;
@Child(name="detail", order=8, min=1, max=Child.MAX_UNLIMITED, type={
IResource.class })
@Description(
shortDefinition="What action is being ordered",
formalDefinition=""
)
private java.util.List<ResourceReferenceDt> myDetail;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myIdentifier, myDate, mySubject, mySource, myTarget, myReason, myAuthority, myWhen, myDetail);
}
@Override
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myIdentifier, myDate, mySubject, mySource, myTarget, myReason, myAuthority, myWhen, myDetail);
}
/**
* Gets the value(s) for <b>identifier</b> (Identifiers assigned to this order by the orderer or by the receiver).
* creating it if it does
* not exist. Will not return <code>null</code>.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public java.util.List<IdentifierDt> getIdentifier() {
if (myIdentifier == null) {
myIdentifier = new java.util.ArrayList<IdentifierDt>();
}
return myIdentifier;
}
/**
* Sets the value(s) for <b>identifier</b> (Identifiers assigned to this order by the orderer or by the receiver)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public Order setIdentifier(java.util.List<IdentifierDt> theValue) {
myIdentifier = theValue;
return this;
}
/**
* Adds and returns a new value for <b>identifier</b> (Identifiers assigned to this order by the orderer or by the receiver)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public IdentifierDt addIdentifier() {
IdentifierDt newType = new IdentifierDt();
getIdentifier().add(newType);
return newType;
}
/**
* Gets the first repetition for <b>identifier</b> (Identifiers assigned to this order by the orderer or by the receiver),
* creating it if it does not already exist.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public IdentifierDt getIdentifierFirstRep() {
if (getIdentifier().isEmpty()) {
return addIdentifier();
}
return getIdentifier().get(0);
}
/**
* Adds a new value for <b>identifier</b> (Identifiers assigned to this order by the orderer or by the receiver)
*
* <p>
* <b>Definition:</b>
*
* </p>
*
* @return Returns a reference to this object, to allow for simple chaining.
*/
public Order addIdentifier( IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) {
if (myIdentifier == null) {
myIdentifier = new java.util.ArrayList<IdentifierDt>();
}
myIdentifier.add(new IdentifierDt(theUse, theSystem, theValue, theLabel));
return this;
}
/**
* Adds a new value for <b>identifier</b> (Identifiers assigned to this order by the orderer or by the receiver)
*
* <p>
* <b>Definition:</b>
*
* </p>
*
* @return Returns a reference to this object, to allow for simple chaining.
*/
public Order addIdentifier( String theSystem, String theValue) {
if (myIdentifier == null) {
myIdentifier = new java.util.ArrayList<IdentifierDt>();
}
myIdentifier.add(new IdentifierDt(theSystem, theValue));
return this;
}
/**
* Gets the value(s) for <b>date</b> (When the order was made).
* creating it if it does
* not exist. Will not return <code>null</code>.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public DateTimeDt getDate() {
if (myDate == null) {
myDate = new DateTimeDt();
}
return myDate;
}
/**
* Sets the value(s) for <b>date</b> (When the order was made)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public Order setDate(DateTimeDt theValue) {
myDate = theValue;
return this;
}
/**
* Sets the value for <b>date</b> (When the order was made)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public Order setDate( Date theDate, TemporalPrecisionEnum thePrecision) {
myDate = new DateTimeDt(theDate, thePrecision);
return this;
}
/**
* Sets the value for <b>date</b> (When the order was made)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public Order setDateWithSecondsPrecision( Date theDate) {
myDate = new DateTimeDt(theDate);
return this;
}
/**
* Gets the value(s) for <b>subject</b> (Patient this order is about).
* creating it if it does
* not exist. Will not return <code>null</code>.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public ResourceReferenceDt getSubject() {
if (mySubject == null) {
mySubject = new ResourceReferenceDt();
}
return mySubject;
}
/**
* Sets the value(s) for <b>subject</b> (Patient this order is about)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public Order setSubject(ResourceReferenceDt theValue) {
mySubject = theValue;
return this;
}
/**
* Gets the value(s) for <b>source</b> (Who initiated the order).
* creating it if it does
* not exist. Will not return <code>null</code>.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public ResourceReferenceDt getSource() {
if (mySource == null) {
mySource = new ResourceReferenceDt();
}
return mySource;
}
/**
* Sets the value(s) for <b>source</b> (Who initiated the order)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public Order setSource(ResourceReferenceDt theValue) {
mySource = theValue;
return this;
}
/**
* Gets the value(s) for <b>target</b> (Who is intended to fulfill the order).
* creating it if it does
* not exist. Will not return <code>null</code>.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public ResourceReferenceDt getTarget() {
return myTarget;
}
/**
* Sets the value(s) for <b>target</b> (Who is intended to fulfill the order)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public Order setTarget(ResourceReferenceDt theValue) {
myTarget = theValue;
return this;
}
/**
* Gets the value(s) for <b>reason[x]</b> (Text - why the order was made).
* creating it if it does
* not exist. Will not return <code>null</code>.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public IDatatype getReason() {
return myReason;
}
/**
* Sets the value(s) for <b>reason[x]</b> (Text - why the order was made)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public Order setReason(IDatatype theValue) {
myReason = theValue;
return this;
}
/**
* Gets the value(s) for <b>authority</b> (If required by policy).
* creating it if it does
* not exist. Will not return <code>null</code>.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public ResourceReferenceDt getAuthority() {
if (myAuthority == null) {
myAuthority = new ResourceReferenceDt();
}
return myAuthority;
}
/**
* Sets the value(s) for <b>authority</b> (If required by policy)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public Order setAuthority(ResourceReferenceDt theValue) {
myAuthority = theValue;
return this;
}
/**
* Gets the value(s) for <b>when</b> (When order should be fulfilled).
* creating it if it does
* not exist. Will not return <code>null</code>.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public When getWhen() {
if (myWhen == null) {
myWhen = new When();
}
return myWhen;
}
/**
* Sets the value(s) for <b>when</b> (When order should be fulfilled)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public Order setWhen(When theValue) {
myWhen = theValue;
return this;
}
/**
* Gets the value(s) for <b>detail</b> (What action is being ordered).
* creating it if it does
* not exist. Will not return <code>null</code>.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public java.util.List<ResourceReferenceDt> getDetail() {
if (myDetail == null) {
myDetail = new java.util.ArrayList<ResourceReferenceDt>();
}
return myDetail;
}
/**
* Sets the value(s) for <b>detail</b> (What action is being ordered)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public Order setDetail(java.util.List<ResourceReferenceDt> theValue) {
myDetail = theValue;
return this;
}
/**
* Adds and returns a new value for <b>detail</b> (What action is being ordered)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public ResourceReferenceDt addDetail() {
ResourceReferenceDt newType = new ResourceReferenceDt();
getDetail().add(newType);
return newType;
}
/**
* Block class for child element: <b>Order.when</b> (When order should be fulfilled)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
@Block()
public static class When extends BaseElement implements IResourceBlock {
@Child(name="code", type=CodeableConceptDt.class, order=0, min=0, max=1)
@Description(
shortDefinition="Code specifies when request should be done. The code may simply be a priority code",
formalDefinition=""
)
private CodeableConceptDt myCode;
@Child(name="schedule", type=ScheduleDt.class, order=1, min=0, max=1)
@Description(
shortDefinition="A formal schedule",
formalDefinition=""
)
private ScheduleDt mySchedule;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myCode, mySchedule);
}
@Override
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myCode, mySchedule);
}
/**
* Gets the value(s) for <b>code</b> (Code specifies when request should be done. The code may simply be a priority code).
* creating it if it does
* not exist. Will not return <code>null</code>.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public CodeableConceptDt getCode() {
if (myCode == null) {
myCode = new CodeableConceptDt();
}
return myCode;
}
/**
* Sets the value(s) for <b>code</b> (Code specifies when request should be done. The code may simply be a priority code)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public When setCode(CodeableConceptDt theValue) {
myCode = theValue;
return this;
}
/**
* Gets the value(s) for <b>schedule</b> (A formal schedule).
* creating it if it does
* not exist. Will not return <code>null</code>.
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public ScheduleDt getSchedule() {
if (mySchedule == null) {
mySchedule = new ScheduleDt();
}
return mySchedule;
}
/**
* Sets the value(s) for <b>schedule</b> (A formal schedule)
*
* <p>
* <b>Definition:</b>
*
* </p>
*/
public When setSchedule(ScheduleDt theValue) {
mySchedule = theValue;
return this;
}
}
}