Data Model Libraries
    Preparing search index...

    Class RequestOrchestration

    RequestOrchestration Class

    A set of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".

    FHIR Specification

    • Short: A set of related requests
    • Definition: A set of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
    • FHIR Version: 5.0.0

    FHIR RequestOrchestration

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? instantiatesCanonical? instantiatesUri? basedOn? replaces? groupIdentifier? requestStatusEnum status requestIntentEnum intent requestPriorityEnum priority? code? subject? encounter? authoredOn? author? reason? goal? note? action?

    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 getGroupIdentifier setGroupIdentifier hasGroupIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getIntentEnumType setIntentEnumType hasIntentEnumType getIntentElement setIntentElement hasIntentElement getIntent setIntent hasIntent getPriorityEnumType setPriorityEnumType hasPriorityEnumType getPriorityElement setPriorityElement hasPriorityElement getPriority setPriority hasPriority getCode setCode hasCode getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getAuthoredOnElement setAuthoredOnElement hasAuthoredOnElement getAuthoredOn setAuthoredOn hasAuthoredOn getAuthor setAuthor hasAuthor getReason setReason addReason hasReason getGoal setGoal addGoal hasGoal getNote setNote addNote hasNote getAction setAction addAction hasAction 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 initReason initGoal initNote initAction

    Constructors

    Properties

    identifier?: Identifier[]

    RequestOrchestration.identifier Element

    FHIR Specification

    • Short: Business identifier
    • Definition: Allows a service to provide a unique, business identifier for the request.
    • Requirements: Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    instantiatesCanonical?: CanonicalType[]

    RequestOrchestration.instantiatesCanonical Element

    FHIR Specification

    • Short: Instantiates FHIR protocol or definition
    • Definition: A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    instantiatesUri?: UriType[]

    RequestOrchestration.instantiatesUri Element

    FHIR Specification

    • Short: Instantiates external protocol or definition
    • Definition: A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    RequestOrchestration.basedOn Element

    FHIR Specification

    • Short: Fulfills plan, proposal, or order
    • Definition: A plan, proposal or order that is fulfilled in whole or in part by this request.
    • Requirements: Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    replaces?: Reference[]

    RequestOrchestration.replaces Element

    FHIR Specification

    • Short: Request(s) replaced by this request
    • Definition: Completed or terminated request(s) whose function is taken by this new request.
    • Comment: The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.
    • Requirements: Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    groupIdentifier?: Identifier

    RequestOrchestration.groupIdentifier Element

    FHIR Specification

    • Short: Composite request this is part of
    • Definition: A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.
    • 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 "prescription" or "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

    RequestOrchestration.status Element

    FHIR Specification

    • Short: draft | active | on-hold | revoked | completed | entered-in-error | unknown
    • Definition: The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration.
    • 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

    RequestOrchestration.intent Element

    FHIR Specification

    • Short: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    • Definition: Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
    • Requirements: Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.
    • 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

    requestPriorityEnum: RequestPriorityEnum

    FHIR CodeSystem: RequestPriority

    RequestPriorityEnum

    priority?: EnumCodeType

    RequestOrchestration.priority Element

    FHIR Specification

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

    CodeSystem Enumeration: RequestPriorityEnum

    code?: CodeableConcept

    RequestOrchestration.code Element

    FHIR Specification

    • Short: What's being requested/ordered
    • Definition: A code that identifies what the overall request orchestration is.
    • Comment: This element can be used to provide a code that captures the meaning of the request orchestration as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request orchestration.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject?: Reference

    RequestOrchestration.subject Element

    FHIR Specification

    encounter?: Reference

    RequestOrchestration.encounter Element

    FHIR Specification

    • Short: Created as part of
    • Definition: Describes the context of the request orchestration, if any.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    authoredOn?: DateTimeType

    RequestOrchestration.authoredOn Element

    FHIR Specification

    • Short: When the request orchestration was authored
    • Definition: Indicates when the request orchestration was created.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    author?: Reference

    RequestOrchestration.author Element

    FHIR Specification

    reason?: CodeableReference[]

    RequestOrchestration.reason Element

    FHIR Specification

    goal?: Reference[]

    RequestOrchestration.goal Element

    FHIR Specification

    • Short: What goals
    • Definition: Goals that are intended to be achieved by following the requests in this RequestOrchestration.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    RequestOrchestration.note Element

    FHIR Specification

    • Short: Additional notes about the response
    • Definition: Provides a mechanism to communicate additional information about the response.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    action?: RequestOrchestrationActionComponent[]

    RequestOrchestration.action Element

    FHIR Specification

    • Short: Proposed actions, if any
    • Definition: The actions, if any, produced by the evaluation of the artifact.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR RequestOrchestration

      • OptionaloptSourceField: string

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

      Returns undefined | RequestOrchestration

      RequestOrchestration data model or undefined for RequestOrchestration

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Subject object value to the subject property.

      Parameters

      • value: undefined | Reference

        the subject object value

      Returns this

      this

      @ReferenceTargets('RequestOrchestration.subject', ['CareTeam','Device','Group','HealthcareService','Location','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson',])

      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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetInstantiatesCanonicalElementsetInstantiatesCanonicalElementaddInstantiatesCanonicalElementhasInstantiatesCanonicalElementgetInstantiatesCanonicalsetInstantiatesCanonicaladdInstantiatesCanonicalhasInstantiatesCanonicalgetInstantiatesUriElementsetInstantiatesUriElementaddInstantiatesUriElementhasInstantiatesUriElementgetInstantiatesUrisetInstantiatesUriaddInstantiatesUrihasInstantiatesUrigetBasedOnsetBasedOnaddBasedOnhasBasedOngetReplacessetReplacesaddReplaceshasReplacesgetGroupIdentifiersetGroupIdentifierhasGroupIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetIntentEnumTypesetIntentEnumTypehasIntentEnumTypegetIntentElementsetIntentElementhasIntentElementgetIntentsetIntenthasIntentgetPriorityEnumTypesetPriorityEnumTypehasPriorityEnumTypegetPriorityElementsetPriorityElementhasPriorityElementgetPrioritysetPriorityhasPrioritygetCodesetCodehasCodegetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetAuthoredOnElementsetAuthoredOnElementhasAuthoredOnElementgetAuthoredOnsetAuthoredOnhasAuthoredOngetAuthorsetAuthorhasAuthorgetReasonsetReasonaddReasonhasReasongetGoalsetGoaladdGoalhasGoalgetNotesetNoteaddNotehasNotegetActionsetActionaddActionhasActionfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitInstantiatesCanonicalinitInstantiatesUriinitBasedOninitReplacesinitReasoninitGoalinitNoteinitAction