Current Build

12.19 JSON Schema for ProcessRequest

Financial Management Work GroupMaturity Level: N/ABallot Status: Informative Compartments: Practitioner

This is a representation of the json schema for ProcessRequest, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/ProcessRequest",
  "$ref": "#/definitions/ProcessRequest",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "ProcessRequest": {
      "description": "This resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.",
      "properties": {
        "resourceType": {
          "description": "This is a ProcessRequest resource",
          "const": "ProcessRequest"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "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.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "identifier": {
          "description": "The ProcessRequest business identifier.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "status": {
          "description": "The status of the resource instance.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "action": {
          "description": "The type of processing action being requested, for example Reversal, Readjudication, StatusRequest, PendedRequest.",
          "enum": [
            "cancel",
            "poll",
            "reprocess",
            "status"
          ]
        },
        "_action": {
          "description": "Extensions for action",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "target": {
          "description": "The organization which is the target of the request.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "created": {
          "description": "The date when this resource was created.",
          "$ref": "#/definitions/dateTime"
        },
        "_created": {
          "description": "Extensions for created",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "provider": {
          "description": "The practitioner who is responsible for the action specified in this request.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "request": {
          "description": "Reference of resource which is the target or subject of this action.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "response": {
          "description": "Reference of a prior response to resource which is the target or subject of this action.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "nullify": {
          "description": "If true remove all history excluding audit.",
          "$ref": "#/definitions/boolean"
        },
        "_nullify": {
          "description": "Extensions for nullify",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "reference": {
          "description": "A reference to supply which authenticates the process.",
          "$ref": "#/definitions/string"
        },
        "_reference": {
          "description": "Extensions for reference",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "item": {
          "description": "List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.",
          "items": {
            "$ref": "#/definitions/ProcessRequest_Item"
          },
          "type": "array"
        },
        "include": {
          "description": "Names of resource types to include.",
          "items": {
            "$ref": "#/definitions/string"
          },
          "type": "array"
        },
        "_include": {
          "description": "Extensions for include",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "exclude": {
          "description": "Names of resource types to exclude.",
          "items": {
            "$ref": "#/definitions/string"
          },
          "type": "array"
        },
        "_exclude": {
          "description": "Extensions for exclude",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "period": {
          "description": "A period of time during which the fulfilling resources would have been created.",
          "$ref": "Period.schema.json#/definitions/Period"
        }
      },
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    },
    "ProcessRequest_Item": {
      "description": "This resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "sequenceLinkId": {
          "description": "A service line number.",
          "$ref": "#/definitions/integer"
        },
        "_sequenceLinkId": {
          "description": "Extensions for sequenceLinkId",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    }
  }
}