8.21.12 JSON Schema for CommunicationRequest

Patient Care Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

This is a representation of the json schema for CommunicationRequest, 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/CommunicationRequest",
  "$ref": "#/definitions/CommunicationRequest",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "CommunicationRequest": {
      "description": "A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.",
      "properties": {
        "resourceType": {
          "description": "This is a CommunicationRequest resource",
          "const": "CommunicationRequest"
        },
        "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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
          "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 and/or the understanding of the containing element\u0027s 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.\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": "Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "basedOn": {
          "description": "A plan or proposal that is fulfilled in whole or in part by this request.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "replaces": {
          "description": "Completed or terminated request(s) whose function is taken by this new request.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "groupIdentifier": {
          "description": "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "status": {
          "description": "The status of the proposal or order.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "statusReason": {
          "description": "Captures the reason for the current state of the CommunicationRequest.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "intent": {
          "description": "Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.",
          "$ref": "#/definitions/code"
        },
        "_intent": {
          "description": "Extensions for intent",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "category": {
          "description": "The type of message to be sent such as alert, notification, reminder, instruction, etc.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "priority": {
          "description": "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.",
          "$ref": "#/definitions/code"
        },
        "_priority": {
          "description": "Extensions for priority",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "doNotPerform": {
          "description": "If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.",
          "$ref": "#/definitions/boolean"
        },
        "_doNotPerform": {
          "description": "Extensions for doNotPerform",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "medium": {
          "description": "A channel that was used for this communication (e.g. email, fax).",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "subject": {
          "description": "The patient or group that is the focus of this communication request.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "about": {
          "description": "Other resources that pertain to this communication request and to which this communication request should be associated.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "encounter": {
          "description": "The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "payload": {
          "description": "Text, attachment(s), or resource(s) to be communicated to the recipient.",
          "items": {
            "$ref": "#/definitions/CommunicationRequest_Payload"
          },
          "type": "array"
        },
        "occurrenceDateTime": {
          "description": "The time when this communication is to occur.",
          "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?$",
          "type": "string"
        },
        "_occurrenceDateTime": {
          "description": "Extensions for occurrenceDateTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "occurrencePeriod": {
          "description": "The time when this communication is to occur.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "authoredOn": {
          "description": "For draft requests, indicates the date of initial creation.  For requests with other statuses, indicates the date of activation.",
          "$ref": "#/definitions/dateTime"
        },
        "_authoredOn": {
          "description": "Extensions for authoredOn",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "requester": {
          "description": "The device, individual, or organization who asks for the information to be shared.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "recipient": {
          "description": "The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "informationProvider": {
          "description": "The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "reason": {
          "description": "Describes why the request is being made in coded or textual form.",
          "items": {
            "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
          },
          "type": "array"
        },
        "note": {
          "description": "Comments made about the request by the requester, sender, recipient, subject or other participants.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    },
    "CommunicationRequest_Payload": {
      "description": "A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.",
      "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 and/or the understanding of the containing element\u0027s 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.\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"
        },
        "contentAttachment": {
          "description": "The communicated content (or for multi-part communications, one portion of the communication).",
          "$ref": "Attachment.schema.json#/definitions/Attachment"
        },
        "contentReference": {
          "description": "The communicated content (or for multi-part communications, one portion of the communication).",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "contentCodeableConcept": {
          "description": "The communicated content (or for multi-part communications, one portion of the communication).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}