Publish-box (todo)
Clinical Genomics Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
This is a representation of the json schema for MolecularSequence, 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/MolecularSequence", "$ref": "#/definitions/MolecularSequence", "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", "definitions": { "MolecularSequence": { "description": "Representation of a molecular sequence.", "properties": { "resourceType": { "description": "This is a MolecularSequence resource", "const": "MolecularSequence" }, "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 managable, 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 managable, 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": "A unique identifier for this particular sequence instance.", "items": { "$ref": "Identifier.schema.json#/definitions/Identifier" }, "type": "array" }, "type": { "description": "The type of the Molecular Sequence (Amino Acid Sequence, DNA Sequence, RNA Sequence).", "$ref": "#/definitions/code" }, "_type": { "description": "Extensions for type", "$ref": "Element.schema.json#/definitions/Element" }, "literal": { "description": "A literal representation of a Molecular Sequence.", "items": { "$ref": "#/definitions/MolecularSequence_Literal" }, "type": "array" }, "file": { "description": "Sequence that was observed as file content. Can be an actual file contents, or referenced by a URL to an external system.", "items": { "$ref": "Attachment.schema.json#/definitions/Attachment" }, "type": "array" }, "relative": { "description": "A Molecular Sequence that is represented as an ordered series of edits on a specified starting sequence.", "items": { "$ref": "#/definitions/MolecularSequence_Relative" }, "type": "array" }, "extracted": { "description": "A Molecular Sequence that is represented as an extracted portion of a different Molecular Sequence.", "items": { "$ref": "#/definitions/MolecularSequence_Extracted" }, "type": "array" }, "repeated": { "description": "A Molecular Sequence that is represented as a repeated sequence motif.", "items": { "$ref": "#/definitions/MolecularSequence_Repeated" }, "type": "array" }, "concatenated": { "description": "A Molecular Sequence that is represented as an ordered concatenation of two or more Molecular Sequences.", "$ref": "#/definitions/MolecularSequence_Concatenated" } }, "type": "object", "additionalProperties": false, "required": [ "resourceType" ] }, "MolecularSequence_Literal": { "description": "Representation of a molecular sequence.", "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 managable, 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 managable, 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" }, "sequenceValue": { "description": "The primary (linear) sequence, expressed as a literal string.", "$ref": "#/definitions/string" }, "_sequenceValue": { "description": "Extensions for sequenceValue", "$ref": "Element.schema.json#/definitions/Element" } }, "type": "object", "additionalProperties": false }, "MolecularSequence_Relative": { "description": "Representation of a molecular sequence.", "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 managable, 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 managable, 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" }, "startingSequence": { "description": "The Molecular Sequence that serves as the starting sequence, on which edits will be applied.", "$ref": "Reference.schema.json#/definitions/Reference" }, "edit": { "description": "An edit (change) made to a sequence.", "items": { "$ref": "#/definitions/MolecularSequence_Edit" }, "type": "array" } }, "type": "object", "additionalProperties": false, "required": [ "startingSequence" ] }, "MolecularSequence_Edit": { "description": "Representation of a molecular sequence.", "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 managable, 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 managable, 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" }, "editOrder": { "description": "The order of this edit, relative to other edits on the starting sequence.", "$ref": "#/definitions/integer" }, "_editOrder": { "description": "Extensions for editOrder", "$ref": "Element.schema.json#/definitions/Element" }, "coordinateSystem": { "description": "The coordinate system used to define the edited intervals on the starting sequence. Coordinate systems are usually 0- or 1-based.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "start": { "description": "The start coordinate of the interval that will be edited.", "$ref": "#/definitions/integer" }, "_start": { "description": "Extensions for start", "$ref": "Element.schema.json#/definitions/Element" }, "end": { "description": "The end coordinate of the interval that will be edited.", "$ref": "#/definitions/integer" }, "_end": { "description": "Extensions for end", "$ref": "Element.schema.json#/definitions/Element" }, "replacementSequence": { "description": "The sequence that defines the replacement sequence used in the edit operation.", "$ref": "Reference.schema.json#/definitions/Reference" }, "replacedSequence": { "description": "The sequence on the \u0027starting\u0027 sequence for the edit operation, defined by the specified interval, that will be replaced during the edit.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "type": "object", "additionalProperties": false, "required": [ "replacementSequence", "coordinateSystem" ] }, "MolecularSequence_Extracted": { "description": "Representation of a molecular sequence.", "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 managable, 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 managable, 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" }, "startingSequence": { "description": "The Molecular Sequence that serves as the parent sequence, from which the intended sequence will be extracted.", "$ref": "Reference.schema.json#/definitions/Reference" }, "start": { "description": "The start coordinate (on the parent sequence) of the interval that defines the subsequence to be extracted.", "$ref": "#/definitions/integer" }, "_start": { "description": "Extensions for start", "$ref": "Element.schema.json#/definitions/Element" }, "end": { "description": "The end coordinate (on the parent sequence) of the interval that defines the subsequence to be extracted.", "$ref": "#/definitions/integer" }, "_end": { "description": "Extensions for end", "$ref": "Element.schema.json#/definitions/Element" }, "coordinateSystem": { "description": "The coordinate system used to define the interval that defines the subsequence to be extracted. Coordinate systems are usually 0- or 1-based.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "reverseComplement": { "description": "A flag that indicates whether the extracted sequence should be reverse complemented.", "$ref": "#/definitions/boolean" }, "_reverseComplement": { "description": "Extensions for reverseComplement", "$ref": "Element.schema.json#/definitions/Element" } }, "type": "object", "additionalProperties": false, "required": [ "startingSequence", "coordinateSystem" ] }, "MolecularSequence_Repeated": { "description": "Representation of a molecular sequence.", "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 managable, 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 managable, 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" }, "sequenceMotif": { "description": "The sequence that defines the repeated motif.", "$ref": "Reference.schema.json#/definitions/Reference" }, "copyCount": { "description": "The number of repeats (copies) of the sequence motif.", "$ref": "#/definitions/integer" }, "_copyCount": { "description": "Extensions for copyCount", "$ref": "Element.schema.json#/definitions/Element" } }, "type": "object", "additionalProperties": false, "required": [ "sequenceMotif" ] }, "MolecularSequence_Concatenated": { "description": "Representation of a molecular sequence.", "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 managable, 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 managable, 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" }, "sequenceElement": { "description": "One element of a concatenated Molecular Sequence.", "items": { "$ref": "#/definitions/MolecularSequence_SequenceElement" }, "type": "array" } }, "type": "object", "additionalProperties": false, "required": [ "sequenceElement" ] }, "MolecularSequence_SequenceElement": { "description": "Representation of a molecular sequence.", "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 managable, 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 managable, 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" }, "sequence": { "description": "The Molecular Sequence corresponding to this element.", "$ref": "Reference.schema.json#/definitions/Reference" }, "ordinalIndex": { "description": "The ordinal position of this sequence element within the concatenated Molecular Sequence.", "$ref": "#/definitions/integer" }, "_ordinalIndex": { "description": "Extensions for ordinalIndex", "$ref": "Element.schema.json#/definitions/Element" } }, "type": "object", "additionalProperties": false, "required": [ "sequence" ] } } }