# Update FHIR r4 request group

Endpoint: PUT /site/{siteId}/fhir/request-group/{id}
Version: 1.0
Security: bearer, bearer

## Path parameters:

  - `siteId` (string, required)
    Site identifier

  - `id` (string, required)
    ID of the RequestGroup to update

## Request fields (application/json):

  - `resourceType` (any, required)
    This is a RequestGroup resource
    Enum: "RequestGroup"

  - `id` (string)
    Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.  (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.)  Ids are case-insensitive.
    Example: "example-id"

  - `meta` (object)
    The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

  - `meta.id` (string)
    An extension object type #string.
    Example: "example-string"

  - `meta.extension` (array)
    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `meta.versionId` (object)
    An extension object type #id.

  - `meta._versionId` (object)
    An extension object type #Element.

  - `meta.lastUpdated` (object)
    An extension object type #instant.

  - `meta._lastUpdated` (object)
    An extension object type #Element.

  - `meta.source` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `meta._source` (object)
    An extension object type #Element.

  - `meta.profile` (array)
    A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
    Example: ["http://example.org/Profile"]

  - `meta.security` (array)
    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

  - `meta.tag` (array)
    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

  - `implicitRules` (string)
    String of characters used to identify a name or a resource
    Example: "https://example.org/resource"

  - `_implicitRules` (object)
    Base definition for all elements in a resource.

  - `language` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_language` (object)
    Base definition for all elements in a resource.

  - `text` (object)
    A human-readable summary of the resource conveying the essential clinical and business information for the resource.

  - `text.status` (any)
    The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
    Enum: "generated", "extensions", "additional", "empty"

  - `text._status` (object)
    An extension object type #Element.

  - `text.div` (string, required)
    An extension object type #xhtml.
    Example: "<div>Example</div>"

  - `contained` (array)
    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
    Example: [{"resourceType":"MedicationRequest","id":"medicationrequest-1","status":"unknown","intent":"proposal","medicationCodeableConcept":{"text":"Medication 1"},"subject":{"reference":"Patient/example"}},{"resourceType":"MedicationRequest","id":"medicationrequest-2","status":"unknown","intent":"proposal","medicationCodeableConcept":{"text":"Medication 2"},"subject":{"reference":"Patient/example"}}]

  - `extension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `extension.url` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `extension._url` (object)
    An extension object type #Element.

  - `extension.valueBase64Binary` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "U2FtcGxl"

  - `extension._valueBase64Binary` (object)
    An extension object type #Element.

  - `extension.valueBoolean` (boolean)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: true

  - `extension._valueBoolean` (object)
    An extension object type #Element.

  - `extension.valueCanonical` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "http://example.org/Profile"

  - `extension._valueCanonical` (object)
    An extension object type #Element.

  - `extension.valueCode` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "sample-code"

  - `extension._valueCode` (object)
    An extension object type #Element.

  - `extension.valueDate` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01"

  - `extension._valueDate` (object)
    An extension object type #Element.

  - `extension.valueDateTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueDateTime` (object)
    An extension object type #Element.

  - `extension.valueDecimal` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1.23

  - `extension._valueDecimal` (object)
    An extension object type #Element.

  - `extension.valueId` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-id"

  - `extension._valueId` (object)
    An extension object type #Element.

  - `extension.valueInstant` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueInstant` (object)
    An extension object type #Element.

  - `extension.valueInteger` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valueInteger` (object)
    An extension object type #Element.

  - `extension.valueMarkdown` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "Sample markdown text"

  - `extension._valueMarkdown` (object)
    An extension object type #Element.

  - `extension.valueOid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:oid:1.2.3.4.5"

  - `extension._valueOid` (object)
    An extension object type #Element.

  - `extension.valuePositiveInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valuePositiveInt` (object)
    An extension object type #Element.

  - `extension.valueString` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-string"

  - `extension._valueString` (object)
    An extension object type #Element.

  - `extension.valueTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "12:00:00"

  - `extension._valueTime` (object)
    An extension object type #Element.

  - `extension.valueUnsignedInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).

  - `extension._valueUnsignedInt` (object)
    An extension object type #Element.

  - `extension.valueUri` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org/resource"

  - `extension._valueUri` (object)
    An extension object type #Element.

  - `extension.valueUrl` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org"

  - `extension._valueUrl` (object)
    An extension object type #Element.

  - `extension.valueUuid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"

  - `extension._valueUuid` (object)
    An extension object type #Element.

  - `extension.valueAddress` (object)
    An extension object type #Address.

  - `extension.valueAge` (object)
    An extension object type #Age.

  - `extension.valueAnnotation` (object)
    An extension object type #Annotation.

  - `extension.valueAttachment` (object)
    An extension object type #Attachment.

  - `extension.valueCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `extension.valueCoding` (object)
    An extension object type #Coding.

  - `extension.valueContactPoint` (object)
    An extension object type #ContactPoint.

  - `extension.valueCount` (object)
    An extension object type #Count.

  - `extension.valueDistance` (object)
    An extension object type #Distance.

  - `extension.valueDuration` (object)
    An extension object type #Duration.

  - `extension.valueHumanName` (object)
    An extension object type #HumanName.

  - `extension.valueIdentifier` (object)
    An extension object type #Identifier.

  - `extension.valueMoney` (object)
    An extension object type #Money.

  - `extension.valuePeriod` (object)
    An extension object type #Period.

  - `extension.valueQuantity` (object)
    An extension object type #Quantity.

  - `extension.valueRange` (object)
    An extension object type #Range.

  - `extension.valueRatio` (object)
    An extension object type #Ratio.

  - `extension.valueReference` (object)
    An extension object type #Reference.

  - `extension.valueSampledData` (object)
    An extension object type #SampledData.

  - `extension.valueSignature` (object)
    An extension object type #Signature.

  - `extension.valueTiming` (object)
    An extension object type #Timing.

  - `extension.valueContactDetail` (object)
    An extension object type #ContactDetail.

  - `extension.valueContributor` (object)
    An extension object type #Contributor.

  - `extension.valueDataRequirement` (object)
    An extension object type #DataRequirement.

  - `extension.valueExpression` (object)
    An extension object type #Expression.

  - `extension.valueParameterDefinition` (object)
    An extension object type #ParameterDefinition.

  - `extension.valueRelatedArtifact` (object)
    An extension object type #RelatedArtifact.

  - `extension.valueTriggerDefinition` (object)
    An extension object type #TriggerDefinition.

  - `extension.valueUsageContext` (object)
    An extension object type #UsageContext.

  - `extension.valueDosage` (object)
    An extension object type #Dosage.

  - `extension.valueMeta` (object)
    An extension object type #Meta.

  - `modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `identifier` (array)
    Allows a service to provide a unique, business identifier for the request.
    Example: [{"value":"requestgroup-1"}]

  - `identifier.use` (any)
    The purpose of this identifier.
    Enum: "usual", "official", "temp", "secondary", "old"

  - `identifier._use` (object)
    An extension object type #Element.

  - `identifier.type` (object)
    An extension object type #CodeableConcept.

  - `identifier.system` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `identifier._system` (object)
    An extension object type #Element.

  - `identifier.value` (string)
    An extension object type #string.
    Example: "example-string"

  - `identifier._value` (object)
    An extension object type #Element.

  - `identifier.period` (object)
    An extension object type #Period.

  - `identifier.assigner` (object)
    An extension object type #Reference.

  - `instantiatesCanonical` (array)
    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.
    Example: ["http://example.org/Profile"]

  - `_instantiatesCanonical` (array)
    Extensions for instantiatesCanonical

  - `instantiatesUri` (array)
    A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
    Example: ["https://example.org/resource"]

  - `_instantiatesUri` (array)
    Extensions for instantiatesUri

  - `basedOn` (array)
    A plan, proposal or order that is fulfilled in whole or in part by this request.

  - `basedOn.reference` (string)
    An extension object type #string.
    Example: "example-string"

  - `basedOn._reference` (object)
    An extension object type #Element.

  - `basedOn.type` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `basedOn._type` (object)
    An extension object type #Element.

  - `basedOn.identifier` (object)
    An extension object type #Identifier.

  - `basedOn.display` (string)
    An extension object type #string.
    Example: "example-string"

  - `basedOn._display` (object)
    An extension object type #Element.

  - `replaces` (array)
    Completed or terminated request(s) whose function is taken by this new request.

  - `groupIdentifier` (object)
    An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

  - `status` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_status` (object)
    Base definition for all elements in a resource.

  - `intent` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_intent` (object)
    Base definition for all elements in a resource.

  - `priority` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_priority` (object)
    Base definition for all elements in a resource.

  - `code` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `code.coding` (array)
    A reference to a code defined by a terminology system.

  - `code.text` (string)
    An extension object type #string.
    Example: "example-string"

  - `code._text` (object)
    An extension object type #Element.

  - `subject` (object)
    A reference from one resource to another.

  - `encounter` (object)
    A reference from one resource to another.

  - `authoredOn` (string)
    A date, date-time or partial date (e.g. just year or year + month).  If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored.                 Dates SHALL be valid dates.
    Example: "2024-01-01T00:00:00Z"

  - `_authoredOn` (object)
    Base definition for all elements in a resource.

  - `author` (object)
    A reference from one resource to another.

  - `reasonCode` (array)
    Describes the reason for the request group in coded or textual form.
    Example: [{"text":"Treatment"}]

  - `reasonReference` (array)
    Indicates another resource whose existence justifies this request group.

  - `note` (array)
    Provides a mechanism to communicate additional information about the response.
    Example: [{"text":"Additional notes about the request group"}]

  - `note.authorReference` (object)
    An extension object type #Reference.

  - `note.authorString` (string)
    The individual responsible for making the annotation.
    Example: "example-string"

  - `note._authorString` (object)
    An extension object type #Element.

  - `note.time` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `note._time` (object)
    An extension object type #Element.

  - `note.text` (object)
    An extension object type #markdown.

  - `action` (array)
    The actions, if any, produced by the evaluation of the artifact.
    Example: [{"prefix":"1","title":"Administer Medications","description":"Administer medications at the appropriate time","textEquivalent":"Administer medication 1, followed an hour later by medication 2","timingDateTime":"2017-03-06T19:00:00Z","participant":[{"reference":"Practitioner/1"}],"groupingBehavior":"logical-group","selectionBehavior":"all","requiredBehavior":"must","precheckBehavior":"yes","cardinalityBehavior":"single","action":[{"id":"medication-action-1","description":"Administer medication 1","type":{"coding":[{"code":"create"}]},"resource":{"reference":"#medicationrequest-1"}},{"id":"medication-action-2","description":"Administer medication 2","relatedAction":[{"actionId":"medication-action-1","relationship":"after-end","offsetDuration":{"value":1,"unit":"h"}}],"type":{"coding":[{"code":"create"}]},"resource":{"reference":"#medicationrequest-2"}}]}]

  - `action.modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `action.prefix` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._prefix` (object)
    An extension object type #Element.

  - `action.title` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._title` (object)
    An extension object type #Element.

  - `action.description` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._description` (object)
    An extension object type #Element.

  - `action.textEquivalent` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._textEquivalent` (object)
    An extension object type #Element.

  - `action.priority` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._priority` (object)
    An extension object type #Element.

  - `action.code` (array)
    A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.

  - `action.documentation` (array)
    Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

  - `action.condition` (array)
    An expression that describes applicability criteria, or start/stop conditions for the action.

  - `action.relatedAction` (array)
    A relationship to another action such as "before" or "30-60 minutes after start of".

  - `action.timingDateTime` (string)
    An optional value describing when the action should be performed.
    Example: "2024-01-01T00:00:00Z"

  - `action._timingDateTime` (object)
    An extension object type #Element.

  - `action.timingAge` (object)
    An extension object type #Age.

  - `action.timingPeriod` (object)
    An extension object type #Period.

  - `action.timingDuration` (object)
    An extension object type #Duration.

  - `action.timingRange` (object)
    An extension object type #Range.

  - `action.timingTiming` (object)
    An extension object type #Timing.

  - `action.participant` (array)
    The participant that should perform or be responsible for this action.

  - `action.groupingBehavior` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._groupingBehavior` (object)
    An extension object type #Element.

  - `action.selectionBehavior` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._selectionBehavior` (object)
    An extension object type #Element.

  - `action.requiredBehavior` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._requiredBehavior` (object)
    An extension object type #Element.

  - `action.precheckBehavior` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._precheckBehavior` (object)
    An extension object type #Element.

  - `action.cardinalityBehavior` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._cardinalityBehavior` (object)
    An extension object type #Element.

  - `action.resource` (object)
    An extension object type #Reference.
    Example: {"resourceType":"Resource","id":"example"}

  - `action.action` (array)
    Sub actions.

## Response 200 fields (application/json):

  - `resourceType` (any, required)
    This is a RequestGroup resource
    Enum: "RequestGroup"

  - `id` (string)
    Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.  (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.)  Ids are case-insensitive.
    Example: "example-id"

  - `meta` (object)
    The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

  - `meta.id` (string)
    An extension object type #string.
    Example: "example-string"

  - `meta.extension` (array)
    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `meta.versionId` (object)
    An extension object type #id.

  - `meta._versionId` (object)
    An extension object type #Element.

  - `meta.lastUpdated` (object)
    An extension object type #instant.

  - `meta._lastUpdated` (object)
    An extension object type #Element.

  - `meta.source` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `meta._source` (object)
    An extension object type #Element.

  - `meta.profile` (array)
    A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
    Example: ["http://example.org/Profile"]

  - `meta.security` (array)
    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

  - `meta.tag` (array)
    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

  - `implicitRules` (string)
    String of characters used to identify a name or a resource
    Example: "https://example.org/resource"

  - `_implicitRules` (object)
    Base definition for all elements in a resource.

  - `language` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_language` (object)
    Base definition for all elements in a resource.

  - `text` (object)
    A human-readable summary of the resource conveying the essential clinical and business information for the resource.

  - `text.status` (any)
    The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
    Enum: "generated", "extensions", "additional", "empty"

  - `text._status` (object)
    An extension object type #Element.

  - `text.div` (string, required)
    An extension object type #xhtml.
    Example: "<div>Example</div>"

  - `contained` (array)
    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
    Example: [{"resourceType":"MedicationRequest","id":"medicationrequest-1","status":"unknown","intent":"proposal","medicationCodeableConcept":{"text":"Medication 1"},"subject":{"reference":"Patient/example"}},{"resourceType":"MedicationRequest","id":"medicationrequest-2","status":"unknown","intent":"proposal","medicationCodeableConcept":{"text":"Medication 2"},"subject":{"reference":"Patient/example"}}]

  - `extension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `extension.url` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `extension._url` (object)
    An extension object type #Element.

  - `extension.valueBase64Binary` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "U2FtcGxl"

  - `extension._valueBase64Binary` (object)
    An extension object type #Element.

  - `extension.valueBoolean` (boolean)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: true

  - `extension._valueBoolean` (object)
    An extension object type #Element.

  - `extension.valueCanonical` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "http://example.org/Profile"

  - `extension._valueCanonical` (object)
    An extension object type #Element.

  - `extension.valueCode` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "sample-code"

  - `extension._valueCode` (object)
    An extension object type #Element.

  - `extension.valueDate` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01"

  - `extension._valueDate` (object)
    An extension object type #Element.

  - `extension.valueDateTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueDateTime` (object)
    An extension object type #Element.

  - `extension.valueDecimal` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1.23

  - `extension._valueDecimal` (object)
    An extension object type #Element.

  - `extension.valueId` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-id"

  - `extension._valueId` (object)
    An extension object type #Element.

  - `extension.valueInstant` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueInstant` (object)
    An extension object type #Element.

  - `extension.valueInteger` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valueInteger` (object)
    An extension object type #Element.

  - `extension.valueMarkdown` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "Sample markdown text"

  - `extension._valueMarkdown` (object)
    An extension object type #Element.

  - `extension.valueOid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:oid:1.2.3.4.5"

  - `extension._valueOid` (object)
    An extension object type #Element.

  - `extension.valuePositiveInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valuePositiveInt` (object)
    An extension object type #Element.

  - `extension.valueString` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-string"

  - `extension._valueString` (object)
    An extension object type #Element.

  - `extension.valueTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "12:00:00"

  - `extension._valueTime` (object)
    An extension object type #Element.

  - `extension.valueUnsignedInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).

  - `extension._valueUnsignedInt` (object)
    An extension object type #Element.

  - `extension.valueUri` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org/resource"

  - `extension._valueUri` (object)
    An extension object type #Element.

  - `extension.valueUrl` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org"

  - `extension._valueUrl` (object)
    An extension object type #Element.

  - `extension.valueUuid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"

  - `extension._valueUuid` (object)
    An extension object type #Element.

  - `extension.valueAddress` (object)
    An extension object type #Address.

  - `extension.valueAge` (object)
    An extension object type #Age.

  - `extension.valueAnnotation` (object)
    An extension object type #Annotation.

  - `extension.valueAttachment` (object)
    An extension object type #Attachment.

  - `extension.valueCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `extension.valueCoding` (object)
    An extension object type #Coding.

  - `extension.valueContactPoint` (object)
    An extension object type #ContactPoint.

  - `extension.valueCount` (object)
    An extension object type #Count.

  - `extension.valueDistance` (object)
    An extension object type #Distance.

  - `extension.valueDuration` (object)
    An extension object type #Duration.

  - `extension.valueHumanName` (object)
    An extension object type #HumanName.

  - `extension.valueIdentifier` (object)
    An extension object type #Identifier.

  - `extension.valueMoney` (object)
    An extension object type #Money.

  - `extension.valuePeriod` (object)
    An extension object type #Period.

  - `extension.valueQuantity` (object)
    An extension object type #Quantity.

  - `extension.valueRange` (object)
    An extension object type #Range.

  - `extension.valueRatio` (object)
    An extension object type #Ratio.

  - `extension.valueReference` (object)
    An extension object type #Reference.

  - `extension.valueSampledData` (object)
    An extension object type #SampledData.

  - `extension.valueSignature` (object)
    An extension object type #Signature.

  - `extension.valueTiming` (object)
    An extension object type #Timing.

  - `extension.valueContactDetail` (object)
    An extension object type #ContactDetail.

  - `extension.valueContributor` (object)
    An extension object type #Contributor.

  - `extension.valueDataRequirement` (object)
    An extension object type #DataRequirement.

  - `extension.valueExpression` (object)
    An extension object type #Expression.

  - `extension.valueParameterDefinition` (object)
    An extension object type #ParameterDefinition.

  - `extension.valueRelatedArtifact` (object)
    An extension object type #RelatedArtifact.

  - `extension.valueTriggerDefinition` (object)
    An extension object type #TriggerDefinition.

  - `extension.valueUsageContext` (object)
    An extension object type #UsageContext.

  - `extension.valueDosage` (object)
    An extension object type #Dosage.

  - `extension.valueMeta` (object)
    An extension object type #Meta.

  - `modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `identifier` (array)
    Allows a service to provide a unique, business identifier for the request.
    Example: [{"value":"requestgroup-1"}]

  - `identifier.use` (any)
    The purpose of this identifier.
    Enum: "usual", "official", "temp", "secondary", "old"

  - `identifier._use` (object)
    An extension object type #Element.

  - `identifier.type` (object)
    An extension object type #CodeableConcept.

  - `identifier.system` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `identifier._system` (object)
    An extension object type #Element.

  - `identifier.value` (string)
    An extension object type #string.
    Example: "example-string"

  - `identifier._value` (object)
    An extension object type #Element.

  - `identifier.period` (object)
    An extension object type #Period.

  - `identifier.assigner` (object)
    An extension object type #Reference.

  - `instantiatesCanonical` (array)
    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.
    Example: ["http://example.org/Profile"]

  - `_instantiatesCanonical` (array)
    Extensions for instantiatesCanonical

  - `instantiatesUri` (array)
    A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
    Example: ["https://example.org/resource"]

  - `_instantiatesUri` (array)
    Extensions for instantiatesUri

  - `basedOn` (array)
    A plan, proposal or order that is fulfilled in whole or in part by this request.

  - `basedOn.reference` (string)
    An extension object type #string.
    Example: "example-string"

  - `basedOn._reference` (object)
    An extension object type #Element.

  - `basedOn.type` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `basedOn._type` (object)
    An extension object type #Element.

  - `basedOn.identifier` (object)
    An extension object type #Identifier.

  - `basedOn.display` (string)
    An extension object type #string.
    Example: "example-string"

  - `basedOn._display` (object)
    An extension object type #Element.

  - `replaces` (array)
    Completed or terminated request(s) whose function is taken by this new request.

  - `groupIdentifier` (object)
    An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

  - `status` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_status` (object)
    Base definition for all elements in a resource.

  - `intent` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_intent` (object)
    Base definition for all elements in a resource.

  - `priority` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_priority` (object)
    Base definition for all elements in a resource.

  - `code` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `code.coding` (array)
    A reference to a code defined by a terminology system.

  - `code.text` (string)
    An extension object type #string.
    Example: "example-string"

  - `code._text` (object)
    An extension object type #Element.

  - `subject` (object)
    A reference from one resource to another.

  - `encounter` (object)
    A reference from one resource to another.

  - `authoredOn` (string)
    A date, date-time or partial date (e.g. just year or year + month).  If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored.                 Dates SHALL be valid dates.
    Example: "2024-01-01T00:00:00Z"

  - `_authoredOn` (object)
    Base definition for all elements in a resource.

  - `author` (object)
    A reference from one resource to another.

  - `reasonCode` (array)
    Describes the reason for the request group in coded or textual form.
    Example: [{"text":"Treatment"}]

  - `reasonReference` (array)
    Indicates another resource whose existence justifies this request group.

  - `note` (array)
    Provides a mechanism to communicate additional information about the response.
    Example: [{"text":"Additional notes about the request group"}]

  - `note.authorReference` (object)
    An extension object type #Reference.

  - `note.authorString` (string)
    The individual responsible for making the annotation.
    Example: "example-string"

  - `note._authorString` (object)
    An extension object type #Element.

  - `note.time` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `note._time` (object)
    An extension object type #Element.

  - `note.text` (object)
    An extension object type #markdown.

  - `action` (array)
    The actions, if any, produced by the evaluation of the artifact.
    Example: [{"prefix":"1","title":"Administer Medications","description":"Administer medications at the appropriate time","textEquivalent":"Administer medication 1, followed an hour later by medication 2","timingDateTime":"2017-03-06T19:00:00Z","participant":[{"reference":"Practitioner/1"}],"groupingBehavior":"logical-group","selectionBehavior":"all","requiredBehavior":"must","precheckBehavior":"yes","cardinalityBehavior":"single","action":[{"id":"medication-action-1","description":"Administer medication 1","type":{"coding":[{"code":"create"}]},"resource":{"reference":"#medicationrequest-1"}},{"id":"medication-action-2","description":"Administer medication 2","relatedAction":[{"actionId":"medication-action-1","relationship":"after-end","offsetDuration":{"value":1,"unit":"h"}}],"type":{"coding":[{"code":"create"}]},"resource":{"reference":"#medicationrequest-2"}}]}]

  - `action.modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `action.prefix` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._prefix` (object)
    An extension object type #Element.

  - `action.title` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._title` (object)
    An extension object type #Element.

  - `action.description` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._description` (object)
    An extension object type #Element.

  - `action.textEquivalent` (string)
    An extension object type #string.
    Example: "example-string"

  - `action._textEquivalent` (object)
    An extension object type #Element.

  - `action.priority` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._priority` (object)
    An extension object type #Element.

  - `action.code` (array)
    A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.

  - `action.documentation` (array)
    Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

  - `action.condition` (array)
    An expression that describes applicability criteria, or start/stop conditions for the action.

  - `action.relatedAction` (array)
    A relationship to another action such as "before" or "30-60 minutes after start of".

  - `action.timingDateTime` (string)
    An optional value describing when the action should be performed.
    Example: "2024-01-01T00:00:00Z"

  - `action._timingDateTime` (object)
    An extension object type #Element.

  - `action.timingAge` (object)
    An extension object type #Age.

  - `action.timingPeriod` (object)
    An extension object type #Period.

  - `action.timingDuration` (object)
    An extension object type #Duration.

  - `action.timingRange` (object)
    An extension object type #Range.

  - `action.timingTiming` (object)
    An extension object type #Timing.

  - `action.participant` (array)
    The participant that should perform or be responsible for this action.

  - `action.groupingBehavior` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._groupingBehavior` (object)
    An extension object type #Element.

  - `action.selectionBehavior` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._selectionBehavior` (object)
    An extension object type #Element.

  - `action.requiredBehavior` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._requiredBehavior` (object)
    An extension object type #Element.

  - `action.precheckBehavior` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._precheckBehavior` (object)
    An extension object type #Element.

  - `action.cardinalityBehavior` (string)
    An extension object type #code.
    Example: "sample-code"

  - `action._cardinalityBehavior` (object)
    An extension object type #Element.

  - `action.resource` (object)
    An extension object type #Reference.
    Example: {"resourceType":"Resource","id":"example"}

  - `action.action` (array)
    Sub actions.

## Response 401 fields (application/json):

  - `message` (string, required)
    Error message indicating unauthorized access.
    Example: "Unauthorized"

  - `statusCode` (number, required)
    HTTP status code for unauthorized access.
    Example: 401


## Response 400 fields

## Response 404 fields