Data Model Libraries
    Preparing search index...

    Class ServiceRequest

    ServiceRequest Class

    A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

    FHIR Specification

    • Short: A request for a service to be performed
    • Definition: A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
    • FHIR Version: 4.3.0

    FHIR ServiceRequest

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? instantiatesCanonical? instantiatesUri? basedOn? replaces? requisition? requestStatusEnum status requestIntentEnum intent category? requestPriorityEnum priority? doNotPerform? code? orderDetail? quantity? subject encounter? occurrence? asNeeded? authoredOn? requester? performerType? performer? locationCode? locationReference? reasonCode? reasonReference? insurance? supportingInfo? specimen? bodySite? note? patientInstruction? relevantHistory?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getInstantiatesCanonicalElement setInstantiatesCanonicalElement addInstantiatesCanonicalElement hasInstantiatesCanonicalElement getInstantiatesCanonical setInstantiatesCanonical addInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement addInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri addInstantiatesUri hasInstantiatesUri getBasedOn setBasedOn addBasedOn hasBasedOn getReplaces setReplaces addReplaces hasReplaces getRequisition setRequisition hasRequisition getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getIntentEnumType setIntentEnumType hasIntentEnumType getIntentElement setIntentElement hasIntentElement getIntent setIntent hasIntent getCategory setCategory addCategory hasCategory getPriorityEnumType setPriorityEnumType hasPriorityEnumType getPriorityElement setPriorityElement hasPriorityElement getPriority setPriority hasPriority getDoNotPerformElement setDoNotPerformElement hasDoNotPerformElement getDoNotPerform setDoNotPerform hasDoNotPerform getCode setCode hasCode getOrderDetail setOrderDetail addOrderDetail hasOrderDetail getQuantity setQuantity hasQuantity getQuantityQuantity hasQuantityQuantity getQuantityRatio hasQuantityRatio getQuantityRange hasQuantityRange getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getOccurrence setOccurrence hasOccurrence getOccurrenceDateTimeType hasOccurrenceDateTimeType getOccurrencePeriod hasOccurrencePeriod getOccurrenceTiming hasOccurrenceTiming getAsNeeded setAsNeeded hasAsNeeded getAsNeededBooleanType hasAsNeededBooleanType getAsNeededCodeableConcept hasAsNeededCodeableConcept getAuthoredOnElement setAuthoredOnElement hasAuthoredOnElement getAuthoredOn setAuthoredOn hasAuthoredOn getRequester setRequester hasRequester getPerformerType setPerformerType hasPerformerType getPerformer setPerformer addPerformer hasPerformer getLocationCode setLocationCode addLocationCode hasLocationCode getLocationReference setLocationReference addLocationReference hasLocationReference getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference getInsurance setInsurance addInsurance hasInsurance getSupportingInfo setSupportingInfo addSupportingInfo hasSupportingInfo getSpecimen setSpecimen addSpecimen hasSpecimen getBodySite setBodySite addBodySite hasBodySite getNote setNote addNote hasNote getPatientInstructionElement setPatientInstructionElement hasPatientInstructionElement getPatientInstruction setPatientInstruction hasPatientInstruction getRelevantHistory setRelevantHistory addRelevantHistory hasRelevantHistory fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initInstantiatesCanonical initInstantiatesUri initBasedOn initReplaces initCategory initOrderDetail initPerformer initLocationCode initLocationReference initReasonCode initReasonReference initInsurance initSupportingInfo initSpecimen initBodySite initNote initRelevantHistory

    Constructors

    Properties

    identifier?: Identifier[]

    ServiceRequest.identifier Element

    FHIR Specification

    • Short: Identifiers assigned to this order
    • Definition: Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
    • Comment: The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    instantiatesCanonical?: CanonicalType[]

    ServiceRequest.instantiatesCanonical Element

    FHIR Specification

    • Short: Instantiates FHIR protocol or definition
    • Definition: The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
    • Comment: Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    instantiatesUri?: UriType[]

    ServiceRequest.instantiatesUri Element

    FHIR Specification

    • Short: Instantiates external protocol or definition
    • Definition: The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
    • Comment: This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    ServiceRequest.basedOn Element

    FHIR Specification

    replaces?: Reference[]

    ServiceRequest.replaces Element

    FHIR Specification

    • Short: What request replaces
    • Definition: The request takes the place of the referenced completed or terminated request(s).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    requisition?: Identifier

    ServiceRequest.requisition Element

    FHIR Specification

    • Short: Composite Request ID
    • Definition: A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
    • Comment: Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
    • Requirements: Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requestStatusEnum: RequestStatusEnum

    FHIR CodeSystem: RequestStatus

    RequestStatusEnum

    status: null | EnumCodeType

    ServiceRequest.status Element

    FHIR Specification

    • Short: draft | active | on-hold | revoked | completed | entered-in-error | unknown
    • Definition: The status of the order.
    • Comment: The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: RequestStatusEnum

    requestIntentEnum: RequestIntentEnum

    FHIR CodeSystem: RequestIntent

    RequestIntentEnum

    intent: null | EnumCodeType

    ServiceRequest.intent Element

    FHIR Specification

    • Short: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    • Definition: Whether the request is a proposal, plan, an original order or a reflex order.
    • Comment: This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
    • isSummary: true

    CodeSystem Enumeration: RequestIntentEnum

    category?: CodeableConcept[]

    ServiceRequest.category Element

    FHIR Specification

    • Short: Classification of service
    • Definition: A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
    • Comment: There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.
    • Requirements: Used for filtering what service request are retrieved and displayed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    requestPriorityEnum: RequestPriorityEnum

    FHIR CodeSystem: RequestPriority

    RequestPriorityEnum

    priority?: EnumCodeType

    ServiceRequest.priority Element

    FHIR Specification

    • Short: routine | urgent | asap | stat
    • Definition: Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: RequestPriorityEnum

    doNotPerform?: BooleanType

    ServiceRequest.doNotPerform Element

    FHIR Specification

    • Short: True if service/procedure should not be performed
    • Definition: Set this to true if the record is saying that the service/procedure should NOT be performed.
    • Comment: In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation.
    • Requirements: Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.
    • isSummary: true
    code?: CodeableConcept

    ServiceRequest.code Element

    FHIR Specification

    • Short: What is being requested/ordered
    • Definition: A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
    • Comment: Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    orderDetail?: CodeableConcept[]

    ServiceRequest.orderDetail Element

    FHIR Specification

    • Short: Additional order information
    • Definition: Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.
    • Comment: For information from the medical record intended to support the delivery of the requested services, use the supportingInformation element.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    quantity?: IDataType

    ServiceRequest.quantity[x] Element

    @ChoiceDataTypesMeta('ServiceRequest.quantity[x]', ['Quantity','Ratio','Range',]

    FHIR Specification

    • Short: Service amount
    • Definition: An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
    • Requirements: When ordering a service the number of service items may need to be specified separately from the the service item.
    • FHIR Types: 'Quantity', 'Ratio', 'Range',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    ServiceRequest.subject Element

    FHIR Specification

    encounter?: Reference

    ServiceRequest.encounter Element

    FHIR Specification

    • Short: Encounter in which the request was created
    • Definition: An encounter that provides additional information about the healthcare context in which this request is made.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    occurrence?: IDataType

    ServiceRequest.occurrence[x] Element

    @ChoiceDataTypesMeta('ServiceRequest.occurrence[x]', ['dateTime','Period','Timing',]

    FHIR Specification

    • Short: When service should occur
    • Definition: The date/time at which the requested service should occur.
    • FHIR Types: 'dateTime', 'Period', 'Timing',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    asNeeded?: IDataType

    ServiceRequest.asNeeded[x] Element

    @ChoiceDataTypesMeta('ServiceRequest.asNeeded[x]', ['boolean','CodeableConcept',]

    FHIR Specification

    • Short: Preconditions for service
    • Definition: If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
    • FHIR Types: 'boolean', 'CodeableConcept',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    authoredOn?: DateTimeType

    ServiceRequest.authoredOn Element

    FHIR Specification

    • Short: Date request signed
    • Definition: When the request transitioned to being actionable.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requester?: Reference

    ServiceRequest.requester Element

    FHIR Specification

    performerType?: CodeableConcept

    ServiceRequest.performerType Element

    FHIR Specification

    • Short: Performer role
    • Definition: Desired type of performer for doing the requested service.
    • Comment: This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, "compounding pharmacy", "psychiatrist" or "internal referral".
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    performer?: Reference[]

    ServiceRequest.performer Element

    FHIR Specification

    locationCode?: CodeableConcept[]

    ServiceRequest.locationCode Element

    FHIR Specification

    • Short: Requested location
    • Definition: The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    locationReference?: Reference[]

    ServiceRequest.locationReference Element

    FHIR Specification

    • Short: Requested location
    • Definition: A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    reasonCode?: CodeableConcept[]

    ServiceRequest.reasonCode Element

    FHIR Specification

    • Short: Explanation/Justification for procedure or service
    • Definition: An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInfo.
    • Comment: This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use CodeableConcept.text element if the data is free (uncoded) text as shown in the CT Scan example.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    reasonReference?: Reference[]

    ServiceRequest.reasonReference Element

    FHIR Specification

    • Short: Explanation/Justification for service or service
    • Definition: Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in supportingInfo.
    • Comment: This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise when referencing DiagnosticReport it should contain a finding in DiagnosticReport.conclusion and/or DiagnosticReport.conclusionCode. When using a reference to DocumentReference, the target document should contain clear findings language providing the relevant reason for this service request. Use the CodeableConcept text element in ServiceRequest.reasonCode if the data is free (uncoded) text as shown in the CT Scan example.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    insurance?: Reference[]

    ServiceRequest.insurance Element

    FHIR Specification

    supportingInfo?: Reference[]

    ServiceRequest.supportingInfo Element

    FHIR Specification

    • Short: Additional clinical information
    • Definition: Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
    • Comment: To represent information about how the services are to be delivered use the instructions element.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    specimen?: Reference[]

    ServiceRequest.specimen Element

    FHIR Specification

    • Short: Procedure Samples
    • Definition: One or more specimens that the laboratory procedure will use.
    • Comment: Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the Specimen resource points to the ServiceRequest.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    bodySite?: CodeableConcept[]

    ServiceRequest.bodySite Element

    FHIR Specification

    • Short: Location on Body
    • Definition: Anatomic location where the procedure should be performed. This is the target site.
    • Comment: Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension procedure-targetBodyStructure.
    • Requirements: Knowing where the procedure is performed is important for tracking if multiple sites are possible.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    note?: Annotation[]

    ServiceRequest.note Element

    FHIR Specification

    • Short: Comments
    • Definition: Any other notes and comments made about the service request. For example, internal billing notes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    patientInstruction?: StringType

    ServiceRequest.patientInstruction Element

    FHIR Specification

    • Short: Patient or consumer-oriented instructions
    • Definition: Instructions in terms that are understood by the patient or consumer.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    relevantHistory?: Reference[]

    ServiceRequest.relevantHistory Element

    FHIR Specification

    • Short: Request provenance
    • Definition: Key events in the history of the request.
    • Comment: This might not include provenances for all versions of the request - only those deemed "relevant" or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a "relevant" change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided ServiceRequest JSON to instantiate the ServiceRequest data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ServiceRequest

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ServiceRequest

      Returns undefined | ServiceRequest

      ServiceRequest data model or undefined for ServiceRequest

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Requester object value to the requester property.

      Parameters

      • value: undefined | Reference

        the requester object value

      Returns this

      this

      @ReferenceTargets('ServiceRequest.requester', ['Practitioner','PractitionerRole','Organization','Patient','RelatedPerson','Device',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Reference array value to the performer property.

      Parameters

      • value: undefined | Reference[]

        the performer array value

      Returns this

      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.

      Parameters

      • value: undefined | Reference

        the performer value

      Returns this

      this

      @ReferenceTargets('ServiceRequest.performer', ['Practitioner','PractitionerRole','Organization','CareTeam','HealthcareService','Patient','Device','RelatedPerson',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Reference array value to the reasonReference property.

      Parameters

      • value: undefined | Reference[]

        the reasonReference array value

      Returns this

      this

      @ReferenceTargets('ServiceRequest.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the reasonReference array property.

      Parameters

      • value: undefined | Reference

        the reasonReference value

      Returns this

      this

      @ReferenceTargets('ServiceRequest.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      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

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetInstantiatesCanonicalElementsetInstantiatesCanonicalElementaddInstantiatesCanonicalElementhasInstantiatesCanonicalElementgetInstantiatesCanonicalsetInstantiatesCanonicaladdInstantiatesCanonicalhasInstantiatesCanonicalgetInstantiatesUriElementsetInstantiatesUriElementaddInstantiatesUriElementhasInstantiatesUriElementgetInstantiatesUrisetInstantiatesUriaddInstantiatesUrihasInstantiatesUrigetBasedOnsetBasedOnaddBasedOnhasBasedOngetReplacessetReplacesaddReplaceshasReplacesgetRequisitionsetRequisitionhasRequisitiongetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetIntentEnumTypesetIntentEnumTypehasIntentEnumTypegetIntentElementsetIntentElementhasIntentElementgetIntentsetIntenthasIntentgetCategorysetCategoryaddCategoryhasCategorygetPriorityEnumTypesetPriorityEnumTypehasPriorityEnumTypegetPriorityElementsetPriorityElementhasPriorityElementgetPrioritysetPriorityhasPrioritygetDoNotPerformElementsetDoNotPerformElementhasDoNotPerformElementgetDoNotPerformsetDoNotPerformhasDoNotPerformgetCodesetCodehasCodegetOrderDetailsetOrderDetailaddOrderDetailhasOrderDetailgetQuantitysetQuantityhasQuantitygetQuantityQuantityhasQuantityQuantitygetQuantityRatiohasQuantityRatiogetQuantityRangehasQuantityRangegetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetOccurrencesetOccurrencehasOccurrencegetOccurrenceDateTimeTypehasOccurrenceDateTimeTypegetOccurrencePeriodhasOccurrencePeriodgetOccurrenceTiminghasOccurrenceTiminggetAsNeededsetAsNeededhasAsNeededgetAsNeededBooleanTypehasAsNeededBooleanTypegetAsNeededCodeableConcepthasAsNeededCodeableConceptgetAuthoredOnElementsetAuthoredOnElementhasAuthoredOnElementgetAuthoredOnsetAuthoredOnhasAuthoredOngetRequestersetRequesterhasRequestergetPerformerTypesetPerformerTypehasPerformerTypegetPerformersetPerformeraddPerformerhasPerformergetLocationCodesetLocationCodeaddLocationCodehasLocationCodegetLocationReferencesetLocationReferenceaddLocationReferencehasLocationReferencegetReasonCodesetReasonCodeaddReasonCodehasReasonCodegetReasonReferencesetReasonReferenceaddReasonReferencehasReasonReferencegetInsurancesetInsuranceaddInsurancehasInsurancegetSupportingInfosetSupportingInfoaddSupportingInfohasSupportingInfogetSpecimensetSpecimenaddSpecimenhasSpecimengetBodySitesetBodySiteaddBodySitehasBodySitegetNotesetNoteaddNotehasNotegetPatientInstructionElementsetPatientInstructionElementhasPatientInstructionElementgetPatientInstructionsetPatientInstructionhasPatientInstructiongetRelevantHistorysetRelevantHistoryaddRelevantHistoryhasRelevantHistoryfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitInstantiatesCanonicalinitInstantiatesUriinitBasedOninitReplacesinitCategoryinitOrderDetailinitPerformerinitLocationCodeinitLocationReferenceinitReasonCodeinitReasonReferenceinitInsuranceinitSupportingInfoinitSpecimeninitBodySiteinitNoteinitRelevantHistory