Release 4B Ballot #1
This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. 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: R4B R4
| Clinical Decision Support Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
This is a representation of the json schema for ResearchElementDefinition, which is just a part of the full JSON Schema.
Clinical Reasoning
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/ResearchElementDefinition",
"$ref": "#/definitions/ResearchElementDefinition",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"ResearchElementDefinition": {
"description": "The ResearchElementDefinition resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.",
"properties": {
"resourceType": {
"description": "This is a ResearchElementDefinition resource",
"const": "ResearchElementDefinition"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "string.schema.json#/definitions/string"
},
"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 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"
},
"url": {
"description": "An absolute URI that is used to identify this research element definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different servers.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"identifier": {
"description": "A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"name": {
"description": "A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the research element definition.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"shortTitle": {
"description": "The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.",
"$ref": "#/definitions/string"
},
"_shortTitle": {
"description": "Extensions for shortTitle",
"$ref": "Element.schema.json#/definitions/Element"
},
"subtitle": {
"description": "An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content.",
"$ref": "#/definitions/string"
},
"_subtitle": {
"description": "Extensions for subtitle",
"$ref": "Element.schema.json#/definitions/Element"
},
"status": {
"description": "The status of this research element definition. Enables tracking the life-cycle of the content.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"experimental": {
"description": "A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "Element.schema.json#/definitions/Element"
},
"subjectCodeableConcept": {
"description": "The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"subjectReference": {
"description": "The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"date": {
"description": "The date (and optionally time) when the research element definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research element definition changes.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual that published the research element definition.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the research element definition from a consumer\u0027s perspective.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"comment": {
"description": "A human-readable string to clarify or explain concepts about the resource.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"_comment": {
"description": "Extensions for comment",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"useContext": {
"description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instances.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the research element definition is intended to be used.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this research element definition is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "Element.schema.json#/definitions/Element"
},
"usage": {
"description": "A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used.",
"$ref": "#/definitions/string"
},
"_usage": {
"description": "Extensions for usage",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyright": {
"description": "A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "Element.schema.json#/definitions/Element"
},
"approvalDate": {
"description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"$ref": "#/definitions/date"
},
"_approvalDate": {
"description": "Extensions for approvalDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"lastReviewDate": {
"description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"$ref": "#/definitions/date"
},
"_lastReviewDate": {
"description": "Extensions for lastReviewDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"effectivePeriod": {
"description": "The period during which the research element definition content was or is planned to be in active use.",
"$ref": "Period.schema.json#/definitions/Period"
},
"topic": {
"description": "Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"author": {
"description": "An individiual or organization primarily involved in the creation and maintenance of the content.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"editor": {
"description": "An individual or organization primarily responsible for internal coherence of the content.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"reviewer": {
"description": "An individual or organization primarily responsible for review of some aspect of the content.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"endorser": {
"description": "An individual or organization responsible for officially endorsing the content for use in some setting.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"relatedArtifact": {
"description": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"items": {
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"type": "array"
},
"library": {
"description": "A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"type": {
"description": "The type of research element, a population, an exposure, or an outcome.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"variableType": {
"description": "The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive).",
"$ref": "#/definitions/code"
},
"_variableType": {
"description": "Extensions for variableType",
"$ref": "Element.schema.json#/definitions/Element"
},
"characteristic": {
"description": "A characteristic that defines the members of the research element. Multiple characteristics are applied with \"and\" semantics.",
"items": {
"$ref": "#/definitions/ResearchElementDefinition_Characteristic"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"characteristic",
"resourceType"
]
},
"ResearchElementDefinition_Characteristic": {
"description": "The ResearchElementDefinition resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.",
"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"
},
"definitionCodeableConcept": {
"description": "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"definitionCanonical": {
"description": "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).",
"pattern": "^\\S*$",
"type": "string"
},
"_definitionCanonical": {
"description": "Extensions for definitionCanonical",
"$ref": "Element.schema.json#/definitions/Element"
},
"definitionExpression": {
"description": "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).",
"$ref": "Expression.schema.json#/definitions/Expression"
},
"definitionDataRequirement": {
"description": "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).",
"$ref": "DataRequirement.schema.json#/definitions/DataRequirement"
},
"usageContext": {
"description": "Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"exclude": {
"description": "When true, members with this characteristic are excluded from the element.",
"$ref": "#/definitions/boolean"
},
"_exclude": {
"description": "Extensions for exclude",
"$ref": "Element.schema.json#/definitions/Element"
},
"unitOfMeasure": {
"description": "Specifies the UCUM unit for the outcome.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"studyEffectiveDescription": {
"description": "A narrative description of the time period the study covers.",
"$ref": "#/definitions/string"
},
"_studyEffectiveDescription": {
"description": "Extensions for studyEffectiveDescription",
"$ref": "Element.schema.json#/definitions/Element"
},
"studyEffectiveDateTime": {
"description": "Indicates what effective period the study covers.",
"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]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$",
"type": "string"
},
"_studyEffectiveDateTime": {
"description": "Extensions for studyEffectiveDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"studyEffectivePeriod": {
"description": "Indicates what effective period the study covers.",
"$ref": "Period.schema.json#/definitions/Period"
},
"studyEffectiveDuration": {
"description": "Indicates what effective period the study covers.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"studyEffectiveTiming": {
"description": "Indicates what effective period the study covers.",
"$ref": "Timing.schema.json#/definitions/Timing"
},
"studyEffectiveTimeFromStart": {
"description": "Indicates duration from the study initiation.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"studyEffectiveGroupMeasure": {
"description": "Indicates how elements are aggregated within the study effective period.",
"$ref": "#/definitions/code"
},
"_studyEffectiveGroupMeasure": {
"description": "Extensions for studyEffectiveGroupMeasure",
"$ref": "Element.schema.json#/definitions/Element"
},
"participantEffectiveDescription": {
"description": "A narrative description of the time period the study covers.",
"$ref": "#/definitions/string"
},
"_participantEffectiveDescription": {
"description": "Extensions for participantEffectiveDescription",
"$ref": "Element.schema.json#/definitions/Element"
},
"participantEffectiveDateTime": {
"description": "Indicates what effective period the study covers.",
"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]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$",
"type": "string"
},
"_participantEffectiveDateTime": {
"description": "Extensions for participantEffectiveDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"participantEffectivePeriod": {
"description": "Indicates what effective period the study covers.",
"$ref": "Period.schema.json#/definitions/Period"
},
"participantEffectiveDuration": {
"description": "Indicates what effective period the study covers.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"participantEffectiveTiming": {
"description": "Indicates what effective period the study covers.",
"$ref": "Timing.schema.json#/definitions/Timing"
},
"participantEffectiveTimeFromStart": {
"description": "Indicates duration from the participant\u0027s study entry.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"participantEffectiveGroupMeasure": {
"description": "Indicates how elements are aggregated within the study effective period.",
"$ref": "#/definitions/code"
},
"_participantEffectiveGroupMeasure": {
"description": "Extensions for participantEffectiveGroupMeasure",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R4B Ballot #1 hl7.fhir.core#4.1.0 generated on Thu, Mar 11, 2021 17:11+1100.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change