0.1.0 - ci-build International flag

HL7CGModels - Local Development build (v0.1.0). See the Directory of published versions

Logical Model: MolecularSequence - Detailed Descriptions

Active as of 2022-03-10

Definitions for the MolecularSequence logical model.

1. MolecularSequence
Definition

Next version of MolecularSequence resource

Control0..*
InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. MolecularSequence.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typestring
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. MolecularSequence.meta
Definition

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.

Control0..1
TypeMeta
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. MolecularSequence.implicitRules
Definition

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.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. MolecularSequence.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages A human language.

Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. MolecularSequence.text
Definition

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.

Control0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. MolecularSequence.contained
Definition

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.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

8. MolecularSequence.extension
Definition

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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MolecularSequence.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. MolecularSequence.modifierExtension
Definition

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's 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MolecularSequence.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. MolecularSequence.name
Definition

The human-readable name of the sequence.

Control0..1
Typestring
11. MolecularSequence.type
Definition

The type of the sequence. Ideally, a code from an ontology would be used to designate genomic (including plasmid and short oligonucleotides), RNA (including mRNA, tRNA, ncRNA, etc), and protein (including short peptides). The bindings for this element have not yet been determined.

Control1..1
TypeCodeableConcept
12. MolecularSequence.identifier[x]
Definition

Identifier(s) for the sequence.

Control0..*
TypeChoice of: http://hl7.org/fhir/uv/cg-model/StructureDefinition/GenomeSequenceDesignation, http://hl7.org/fhir/uv/cg-model/StructureDefinition/IdentifierSequenceDesignation
[x] NoteSee Choice of Data Types for further information about how to use [x]
13. MolecularSequence.representations
Definition

This element allows a single instance of Sequence to be represented in many different ways, including different file formats.

Control0..*
TypeBackboneElement
14. MolecularSequence.representations.literal
Definition

A sequence represented as a literal string

Control0..1
TypeBackboneElement
15. MolecularSequence.representations.literal.encoding
Definition

The coding system (alphabet) used by the sequence. While IUPAC symbols are frequently assumed, this attribute can denote whether an amino acid sequence is encoded as single letter or 3-letter abbreviations. Ideally, a value set defining common coding systewould be developed.

Control0..1
TypeCodeableConcept
16. MolecularSequence.representations.literal.value
Definition

The literal sequence expressed as a string

Control1..1
Typestring
17. MolecularSequence.representations.formatted
Definition

A sequence expressed in a pre-defined format. The attached sequence can be processed using existing software tools designed for the given format.

Control0..1
TypeBackboneElement
18. MolecularSequence.representations.formatted.file
Definition

A file containing the formatted sequence.

Control1..1
TypeAttachment
19. MolecularSequence.representations.resolveable
Definition

Reference to a sequence that is not explicitly provided within this instance of Sequence, but which can be retrieved by resolving the URI

Control0..1
TypeBackboneElement
20. MolecularSequence.representations.resolveable.uri
Definition

A resolvable, absolute address that, when accessed, will return the Sequence

Control1..1
Typeuri
21. MolecularSequence.representations.resolveable.format
Definition

The format of the resolved sequence. The codes for this element should be the same as those for a Formatted Sequence.

Control0..1
Typecode
22. MolecularSequence.representations.relative
Definition

The definition of a new sequence that is represented by applying an ordered series of edits to one or more other Sequences.

Control0..1
TypeBackboneElement
23. MolecularSequence.representations.relative.startingSequence[x]
Definition

A reference to the Sequence used as the starting "base" of the Sequence that is to be derived.

Control1..1
TypeChoice of: string, Reference(MolecularSequence)
[x] NoteSee Choice of Data Types for further information about how to use [x]
24. MolecularSequence.representations.relative.edits
Definition

An ordered series of edits to apply to the starting sequence

Control1..*
TypeBackboneElement
25. MolecularSequence.representations.relative.edits.interval
Definition

The coordinate interval that defines the region of Sequence to be replaced during the current edit operation

Control1..1
Typehttp://hl7.org/fhir/uv/cg-model/StructureDefinition/MolecularPreciseInterval
26. MolecularSequence.representations.relative.edits.referenceSequence[x]
Definition

The content of the sub-Sequence that will be replaced in the current edit operation

Control0..1
TypeChoice of: string, Reference(MolecularSequence)
[x] NoteSee Choice of Data Types for further information about how to use [x]
27. MolecularSequence.representations.relative.edits.replacementSequence[x]
Definition

The replacement Sequence used in the current edit operation

Control1..1
TypeChoice of: string, Reference(MolecularSequence)
[x] NoteSee Choice of Data Types for further information about how to use [x]
28. MolecularSequence.relationship
Definition

This element captures information about the relationship between two Sequences. Ideally, the relationship will be codified using concepts from an ontology.

Control0..*
TypeBackboneElement
29. MolecularSequence.relationship.type
Definition

The relationship between two sequences. For example: transcribed to, transcribed from, translated to, translated from. Ideally, the concepts used to express the relationship should be defined in an ontology.

Control1..1
TypeCodeableConcept
30. MolecularSequence.relationship.description
Definition

A description of the relationship between two sequences.

Control0..1
Typestring
31. MolecularSequence.relationship.sequence
Definition

A reference to a Sequence that represents the object of a defined relationship.

Control1..1
TypeReference(MolecularSequence)