8.23.11 JSON Schema for ResearchSubject

Biomedical Research and Regulation Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Device, Patient

This is a representation of the json schema for ResearchSubject, 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/ResearchSubject",
  "$ref": "#/definitions/ResearchSubject",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "ResearchSubject": {
      "description": "A physical entity which is the primary unit of operational and/or administrative interest in a study.",
      "properties": {
        "resourceType": {
          "description": "This is a ResearchSubject resource",
          "const": "ResearchSubject"
        },
        "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": "Identifiers assigned to this research subject for a study.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "status": {
          "description": "The publication state of the resource (not of the subject).",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "progress": {
          "description": "The current state (status) of the subject and resons for status change where appropriate.",
          "items": {
            "$ref": "#/definitions/ResearchSubject_Progress"
          },
          "type": "array"
        },
        "period": {
          "description": "The dates the subject began and ended their participation in the study.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "study": {
          "description": "Reference to the study the subject is participating in.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "subject": {
          "description": "The record of the person, animal or other entity involved in the study.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "assignedArm": {
          "description": "The name of the arm in the study the subject is expected to follow as part of this study.",
          "$ref": "#/definitions/string"
        },
        "_assignedArm": {
          "description": "Extensions for assignedArm",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "actualArm": {
          "description": "The name of the arm in the study the subject actually followed as part of this study.",
          "$ref": "#/definitions/string"
        },
        "_actualArm": {
          "description": "Extensions for actualArm",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "consent": {
          "description": "A record of the patient\u0027s informed agreement to participate in the study.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "study",
        "subject",
        "resourceType"
      ]
    },
    "ResearchSubject_Progress": {
      "description": "A physical entity which is the primary unit of operational and/or administrative interest in a study.",
      "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"
        },
        "type": {
          "description": "Identifies the aspect of the subject\u0027s journey that the state refers to.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "subjectState": {
          "description": "The current state of the subject.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "milestone": {
          "description": "The milestones the subject has passed through.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "reason": {
          "description": "The reason for the state change.  If coded it should follow the formal subject state model.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "startDate": {
          "description": "The date when the new status started.",
          "$ref": "#/definitions/dateTime"
        },
        "_startDate": {
          "description": "Extensions for startDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "endDate": {
          "description": "The date when the state ended.",
          "$ref": "#/definitions/dateTime"
        },
        "_endDate": {
          "description": "Extensions for endDate",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}