Private OptionalidentifierServiceRequest.identifier Element
FHIR Specification
IdentifierPrivate OptionalinstantiatesServiceRequest.instantiatesCanonical Element
FHIR Specification
canonical
Private OptionalinstantiatesServiceRequest.instantiatesUri Element
FHIR Specification
uriPrivate OptionalbasedServiceRequest.basedOn Element
Private OptionalreplacesServiceRequest.replaces Element
FHIR Specification
Reference
Private OptionalrequisitionServiceRequest.requisition Element
FHIR Specification
IdentifierPrivate ReadonlyrequestFHIR CodeSystem: RequestStatus
PrivatestatusServiceRequest.status Element
FHIR Specification
codeCodeSystem Enumeration: RequestStatusEnum
Private ReadonlyrequestFHIR CodeSystem: RequestIntent
PrivateintentServiceRequest.intent Element
FHIR Specification
codeCodeSystem Enumeration: RequestIntentEnum
Private OptionalcategoryServiceRequest.category Element
FHIR Specification
CodeableConceptPrivate ReadonlyrequestFHIR CodeSystem: RequestPriority
Private OptionalpriorityServiceRequest.priority Element
FHIR Specification
codeCodeSystem Enumeration: RequestPriorityEnum
Private OptionaldoServiceRequest.doNotPerform Element
FHIR Specification
booleanPrivate OptionalcodeServiceRequest.code Element
FHIR Specification
CodeableReference
Private OptionalorderServiceRequest.orderDetail Element
FHIR Specification
supportingInformation element.BackboneElementPrivate OptionalquantityServiceRequest.quantity[x] Element
FHIR Specification
PrivatesubjectServiceRequest.subject Element
FHIR Specification
Reference
Private OptionalfocusServiceRequest.focus Element
FHIR Specification
Reference
Private OptionalencounterServiceRequest.encounter Element
FHIR Specification
Reference
Private OptionaloccurrenceServiceRequest.occurrence[x] Element
Private OptionalasServiceRequest.asNeeded[x] Element
Private OptionalauthoredServiceRequest.authoredOn Element
Private OptionalrequesterServiceRequest.requester Element
FHIR Specification
Reference
Private OptionalperformerServiceRequest.performerType Element
FHIR Specification
CodeableConceptPrivate OptionalperformerServiceRequest.performer Element
FHIR Specification
Reference
Private OptionallocationServiceRequest.location Element
FHIR Specification
CodeableReference
Private OptionalreasonServiceRequest.reason Element
FHIR Specification
supportingInfo.concept.text element if the data is free (uncoded) text as shown in the CT Scan example.CodeableReference
Private OptionalinsuranceServiceRequest.insurance Element
FHIR Specification
Reference
Private OptionalsupportingServiceRequest.supportingInfo Element
FHIR Specification
instructions element.CodeableReference
Private OptionalspecimenServiceRequest.specimen Element
FHIR Specification
Reference
Private OptionalbodyServiceRequest.bodySite Element
FHIR Specification
CodeableConceptPrivate OptionalbodyServiceRequest.bodyStructure Element
FHIR Specification
Reference
Private OptionalnoteServiceRequest.note Element
Private OptionalpatientServiceRequest.patientInstruction Element
Private OptionalrelevantServiceRequest.relevantHistory Element
FHIR Specification
Reference
StaticparseParse the provided ServiceRequest JSON to instantiate the ServiceRequest data model.
JSON representing FHIR ServiceRequest
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ServiceRequest
ServiceRequest data model or undefined for ServiceRequest
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the instantiatesCanonical property value as a CanonicalType array
Assigns the provided CanonicalType array value to the instantiatesCanonical property.
the instantiatesCanonical array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the instantiatesCanonical array property.
the instantiatesCanonical value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the instantiatesCanonical property exists and has a value; false otherwise
the instantiatesCanonical property value as a fhirCanonical array
Assigns the provided primitive value array to the instantiatesCanonical property.
the instantiatesCanonical value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the instantiatesCanonical array property.
the instantiatesCanonical value
this
PrimitiveTypeError for invalid primitive types
true if the instantiatesCanonical property exists and has a value; false otherwise
the instantiatesUri property value as a UriType array
Assigns the provided UriType array value to the instantiatesUri property.
the instantiatesUri array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided UriType value to the instantiatesUri array property.
the instantiatesUri value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the instantiatesUri property exists and has a value; false otherwise
the instantiatesUri property value as a fhirUri array
Assigns the provided primitive value array to the instantiatesUri property.
the instantiatesUri value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the instantiatesUri array property.
the instantiatesUri value
this
PrimitiveTypeError for invalid primitive types
true if the instantiatesUri property exists and has a value; false otherwise
the basedOn property value as a Reference array
Assigns the provided Reference array value to the basedOn property.
the basedOn array value
this
@ReferenceTargets('ServiceRequest.basedOn', ['CarePlan','ServiceRequest','MedicationRequest',])
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the basedOn array property.
the basedOn value
this
@ReferenceTargets('ServiceRequest.basedOn', ['CarePlan','ServiceRequest','MedicationRequest',])
InvalidTypeError for invalid data type or reference value
true if the basedOn property exists and has a value; false otherwise
the replaces property value as a Reference array
Assigns the provided Reference array value to the replaces property.
the replaces array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the replaces array property.
the replaces value
this
InvalidTypeError for invalid data type or reference value
true if the replaces property exists and has a value; false otherwise
the requisition property value as a Identifier object if defined; else an empty Identifier object
Assigns the provided Requisition object value to the requisition property.
the requisition object value
this
InvalidTypeError for invalid data types
true if the requisition property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: RequestStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: RequestStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: RequestStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: RequestStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: RequestStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: RequestStatusEnum
true if the status property exists and has a value; false otherwise
the intent property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: RequestIntentEnum
Assigns the provided EnumCodeType value to the intent property.
the intent value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: RequestIntentEnum
true if the intent property exists and has a value; false otherwise
the intent property value as a CodeType if defined; else null
CodeSystem Enumeration: RequestIntentEnum
Assigns the provided PrimitiveType value to the intent property.
the intent value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: RequestIntentEnum
true if the intent property exists and has a value; false otherwise
the intent property value as a fhirCode if defined; else null
CodeSystem Enumeration: RequestIntentEnum
Assigns the provided primitive value to the intent property.
the intent value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: RequestIntentEnum
true if the intent property exists and has a value; false otherwise
the category property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the category property.
the category array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the category array property.
the category value
this
InvalidTypeError for invalid data types
true if the category property exists and has a value; false otherwise
the priority property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: RequestPriorityEnum
Assigns the provided EnumCodeType value to the priority property.
the priority value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: RequestPriorityEnum
true if the priority property exists and has a value; false otherwise
the priority property value as a CodeType if defined; else undefined
CodeSystem Enumeration: RequestPriorityEnum
Assigns the provided PrimitiveType value to the priority property.
the priority value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: RequestPriorityEnum
true if the priority property exists and has a value; false otherwise
the priority property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: RequestPriorityEnum
Assigns the provided primitive value to the priority property.
the priority value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: RequestPriorityEnum
true if the priority property exists and has a value; false otherwise
the doNotPerform property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the doNotPerform property.
the doNotPerform value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the doNotPerform property exists and has a value; false otherwise
the doNotPerform property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the doNotPerform property.
the doNotPerform value
this
PrimitiveTypeError for invalid primitive types
true if the doNotPerform property exists and has a value; false otherwise
the code property value as a CodeableReference object if defined; else an empty CodeableReference object
Assigns the provided Code object value to the code property.
the code object value
this
InvalidTypeError for invalid data types
true if the code property exists and has a value; false otherwise
the orderDetail property value as a ServiceRequestOrderDetailComponent array
Assigns the provided ServiceRequestOrderDetailComponent array value to the orderDetail property.
the orderDetail array value
this
InvalidTypeError for invalid data types
Add the provided ServiceRequestOrderDetailComponent value to the orderDetail array property.
the orderDetail value
this
InvalidTypeError for invalid data types
true if the orderDetail property exists and has a value; false otherwise
the quantity property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the quantity property.
the quantity object value
this
InvalidTypeError for invalid data types
true if the quantity property exists and has a value; false otherwise
the quantity property value as a Quantity object if defined; else undefined
true if the quantity property exists as a Quantity and has a value; false otherwise
the quantity property value as a Ratio object if defined; else undefined
true if the quantity property exists as a Ratio and has a value; false otherwise
the quantity property value as a Range object if defined; else undefined
true if the quantity property exists as a Range and has a value; false otherwise
the subject property value as a Reference object if defined; else an empty Reference object
Assigns the provided Subject object value to the subject property.
the subject object value
this
InvalidTypeError for invalid data type or reference value
true if the subject property exists and has a value; false otherwise
the focus property value as a Reference array
Assigns the provided Reference array value to the focus property.
the focus array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the focus array property.
the focus value
this
InvalidTypeError for invalid data type or reference value
true if the focus property exists and has a value; false otherwise
the encounter property value as a Reference object; else an empty Reference object
Assigns the provided Encounter object value to the encounter property.
the encounter object value
this
InvalidTypeError for invalid data type or reference value
true if the encounter property exists and has a value; false otherwise
the occurrence property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the occurrence property.
the occurrence object value
this
InvalidTypeError for invalid data types
true if the occurrence property exists and has a value; false otherwise
the occurrence property value as a DateTimeType object if defined; else undefined
true if the occurrence property exists as a DateTimeType and has a value; false otherwise
the occurrence property value as a Period object if defined; else undefined
true if the occurrence property exists as a Period and has a value; false otherwise
the occurrence property value as a Timing object if defined; else undefined
true if the occurrence property exists as a Timing and has a value; false otherwise
the asNeeded property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the asNeeded property.
the asNeeded object value
this
InvalidTypeError for invalid data types
true if the asNeeded property exists and has a value; false otherwise
the asNeeded property value as a BooleanType object if defined; else undefined
true if the asNeeded property exists as a BooleanType and has a value; false otherwise
the asNeeded property value as a CodeableConcept object if defined; else undefined
true if the asNeeded property exists as a CodeableConcept and has a value; false otherwise
the authoredOn property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the authoredOn property.
the authoredOn value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the authoredOn property exists and has a value; false otherwise
the authoredOn property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the authoredOn property.
the authoredOn value
this
PrimitiveTypeError for invalid primitive types
true if the authoredOn property exists and has a value; false otherwise
the requester property value as a Reference object; else an empty Reference object
Assigns the provided Requester object value to the requester property.
the requester object value
this
@ReferenceTargets('ServiceRequest.requester', ['Practitioner','PractitionerRole','Organization','Patient','RelatedPerson','Device',])
InvalidTypeError for invalid data type or reference value
true if the requester property exists and has a value; false otherwise
the performerType property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided PerformerType object value to the performerType property.
the performerType object value
this
InvalidTypeError for invalid data types
true if the performerType property exists and has a value; false otherwise
the performer property value as a Reference array
Assigns the provided Reference array value to the performer property.
the performer array value
this
@ReferenceTargets('ServiceRequest.performer', ['Practitioner','PractitionerRole','Organization','CareTeam','HealthcareService','Patient','Device','RelatedPerson',])
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the performer array property.
the performer value
this
@ReferenceTargets('ServiceRequest.performer', ['Practitioner','PractitionerRole','Organization','CareTeam','HealthcareService','Patient','Device','RelatedPerson',])
InvalidTypeError for invalid data type or reference value
true if the performer property exists and has a value; false otherwise
the location property value as a CodeableReference array
Assigns the provided CodeableReference array value to the location property.
the location array value
this
InvalidTypeError for invalid data types
Add the provided CodeableReference value to the location array property.
the location value
this
InvalidTypeError for invalid data types
true if the location property exists and has a value; false otherwise
the reason property value as a CodeableReference array
Assigns the provided CodeableReference array value to the reason property.
the reason array value
this
InvalidTypeError for invalid data types
Add the provided CodeableReference value to the reason array property.
the reason value
this
InvalidTypeError for invalid data types
true if the reason property exists and has a value; false otherwise
the insurance property value as a Reference array
Assigns the provided Reference array value to the insurance property.
the insurance array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the insurance array property.
the insurance value
this
InvalidTypeError for invalid data type or reference value
true if the insurance property exists and has a value; false otherwise
the supportingInfo property value as a CodeableReference array
Assigns the provided CodeableReference array value to the supportingInfo property.
the supportingInfo array value
this
InvalidTypeError for invalid data types
Add the provided CodeableReference value to the supportingInfo array property.
the supportingInfo value
this
InvalidTypeError for invalid data types
true if the supportingInfo property exists and has a value; false otherwise
the specimen property value as a Reference array
Assigns the provided Reference array value to the specimen property.
the specimen array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the specimen array property.
the specimen value
this
InvalidTypeError for invalid data type or reference value
true if the specimen property exists and has a value; false otherwise
the bodySite property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the bodySite property.
the bodySite array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the bodySite array property.
the bodySite value
this
InvalidTypeError for invalid data types
true if the bodySite property exists and has a value; false otherwise
the bodyStructure property value as a Reference object; else an empty Reference object
Assigns the provided BodyStructure object value to the bodyStructure property.
the bodyStructure object value
this
InvalidTypeError for invalid data type or reference value
true if the bodyStructure property exists and has a value; false otherwise
the note property value as a Annotation array
Assigns the provided Annotation array value to the note property.
the note array value
this
InvalidTypeError for invalid data types
Add the provided Annotation value to the note array property.
the note value
this
InvalidTypeError for invalid data types
true if the note property exists and has a value; false otherwise
the patientInstruction property value as a ServiceRequestPatientInstructionComponent array
Assigns the provided ServiceRequestPatientInstructionComponent array value to the patientInstruction property.
the patientInstruction array value
this
InvalidTypeError for invalid data types
Add the provided ServiceRequestPatientInstructionComponent value to the patientInstruction array property.
the patientInstruction value
this
InvalidTypeError for invalid data types
true if the patientInstruction property exists and has a value; false otherwise
the relevantHistory property value as a Reference array
Assigns the provided Reference array value to the relevantHistory property.
the relevantHistory array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the relevantHistory array property.
the relevantHistory value
this
InvalidTypeError for invalid data type or reference value
true if the relevantHistory property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the instantiatesCanonical property
PrivateinitInitialize the instantiatesUri property
PrivateinitInitialize the basedOn property
PrivateinitInitialize the replaces property
PrivateinitInitialize the category property
PrivateinitInitialize the orderDetail property
PrivateinitInitialize the focus property
PrivateinitInitialize the performer property
PrivateinitInitialize the location property
PrivateinitInitialize the reason property
PrivateinitInitialize the insurance property
PrivateinitInitialize the supportingInfo property
PrivateinitInitialize the specimen property
PrivateinitInitialize the bodySite property
PrivateinitInitialize the note property
PrivateinitInitialize the patientInstruction property
PrivateinitInitialize the relevantHistory property
ServiceRequest Class
Remarks
A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
FHIR Specification
See
FHIR ServiceRequest