This page is part of the FHIR Specification (v4.0.1: (v3.3.0: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). Ballot 2). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Content Detailed Descriptions

Mappings 8.26 JSON Schema for ResearchSubject JSON Extension: effectivePeriod

FHIR Infrastructure Biomedical Research and Regulation Work Group

Maturity Level : 1 N/A

Ballot Status : Informative

Use Context Compartments : Any URL for this extension: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod Status: draft. Extension maintained by: HL7 The period during which the resource content was or is planned to be effective. Comment : The effective period for a resource determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015. Context of Use: Use on Element ID StructureDefinition, Element ID StructureMap, Element ID CapabilityStatement, Element ID OperationDefinition, Element ID SearchParameter, Element ID CompartmentDefinition, Element ID ImplementationGuide, Element ID CodeSystem, Element ID ValueSet, Element ID ConceptMap or Element ID NamingSystem Extension Content Summary Full Structure XML JSON All Summary Name Flags Card. Type Description & Constraints effectivePeriod 0..1 Period URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod effectivePeriod: The period during which the resource content was or is planned to be effective. Use on Element ID StructureDefinition, Element ID StructureMap, Element ID CapabilityStatement, Element ID OperationDefinition, Element ID SearchParameter, Element ID CompartmentDefinition, Element ID ImplementationGuide, Element ID CodeSystem, Element ID ValueSet, Element ID ConceptMap or Element ID NamingSystem Documentation for this format Patient

Full Structure Name Flags Card. Type Description & Constraints extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod effectivePeriod: The period during which the resource content was or This is planned to be effective. Use on Element ID StructureDefinition, Element ID StructureMap, Element ID CapabilityStatement, Element ID OperationDefinition, Element ID SearchParameter, Element ID CompartmentDefinition, Element ID ImplementationGuide, Element ID CodeSystem, Element ID ValueSet, Element ID ConceptMap or Element ID NamingSystem extension I 0..0 url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod" value[x] I 1..1 Period Value a representation of extension Documentation for this format XML Template <!-- effectivePeriod --> < xmlns="http://hl7.org/fhir" url="" > <!-- from Element: <</valuePeriod> </extension> JSON Template { // // from Element: " ] " " } Summary Name Flags Card. Type Description & Constraints effectivePeriod 0..1 Period URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod effectivePeriod: The period during which the resource content was or is planned to be effective. Use on Element ID StructureDefinition, Element ID StructureMap, Element ID CapabilityStatement, Element ID OperationDefinition, Element ID SearchParameter, Element ID CompartmentDefinition, Element ID ImplementationGuide, Element ID CodeSystem, Element ID ValueSet, Element ID ConceptMap or Element ID NamingSystem Documentation json schema for this format Full Structure Name Flags Card. Type Description & Constraints extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod effectivePeriod: The period during ResearchSubject, which the resource content was or is planned to be effective. Use on Element ID StructureDefinition, Element ID StructureMap, Element ID CapabilityStatement, Element ID OperationDefinition, Element ID SearchParameter, Element ID CompartmentDefinition, Element ID ImplementationGuide, Element ID CodeSystem, Element ID ValueSet, Element ID ConceptMap or Element ID NamingSystem extension I 0..0 url 1..1 uri "http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod" value[x] I 1..1 Period Value just a part of extension Documentation for this format XML Template <!-- effectivePeriod --> < xmlns="http://hl7.org/fhir" url="" > <!-- from Element: <</valuePeriod> </extension> the full JSON Template Schema .

{ // // from Element: " ] " "

{
  "$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, 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.",
          "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 current state of the subject.",
          "enum": [
            "candidate",
            "eligible",
            "follow-up",
            "ineligible",
            "not-registered",
            "off-study",
            "on-study",
            "on-study-intervention",
            "on-study-observation",
            "pending-on-study",
            "potential-candidate",
            "screening",
            "withdrawn"
          ]
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "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"
        },
        "individual": {
          "description": "The record of the person or animal who is 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"
        }
      },
      "additionalProperties": false,
      "required": [
        "study",
        "individual",
        "resourceType"
      ]
    }

  }
}