0.1.0 - ci-build
HL7CGModels - Local Development build (v0.1.0). See the Directory of published versions
Draft as of 2022-03-10 |
Definitions for the GenomicStudy logical model.
1. GenomicStudy | |
Definition | A Genomic Study is a set of files and procedures that are performed to generate and analyze genomic data. |
Control | 0..* |
Invariants | Defined 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. GenomicStudy.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | string |
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. GenomicStudy.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. |
Control | 0..1 |
Type | Meta |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
4. GenomicStudy.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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
5. GenomicStudy.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | The codes SHOULD be taken from CommonLanguages Max Binding: AllLanguages A human language. |
Type | code |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. GenomicStudy.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. |
Control | 0..1 |
Type | Narrative |
Alternate Names | narrative, 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. GenomicStudy.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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline 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. GenomicStudy.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on GenomicStudy.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
9. GenomicStudy.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). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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 Names | extensions, 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. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on GenomicStudy.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
10. GenomicStudy.identifier | |
Definition | An identifier for this genomic study |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
11. GenomicStudy.status | |
Definition | The status of the genomic study |
Control | 0..1 |
Type | CodeableConcept |
12. GenomicStudy.type | |
Definition | The type of the study |
Control | 0..1 |
Type | CodeableConcept |
13. GenomicStudy.subject | |
Definition | The subject of the genomic study |
Control | 1..1 |
Type | Reference(Patient) |
14. GenomicStudy.encounter | |
Definition | The healthcare encounter with which this genomics study is associated |
Control | 0..1 |
Type | Reference(Encounter) |
15. GenomicStudy.startDate | |
Definition | When the genomic study was started |
Control | 0..1 |
Type | dateTime |
16. GenomicStudy.basedOn | |
Definition | Event resources that the genomic study is based on |
Control | 0..* |
Type | Reference(ServiceRequest | Task) |
17. GenomicStudy.referrer | |
Definition | Healthcare professional(s) who requested or referred the genomic study |
Control | 0..1 |
Type | Reference(Practitioner | PractitionerRole) |
18. GenomicStudy.interpreter | |
Definition | Healthcare professional(s) who interpreted the genomic study |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole) |
19. GenomicStudy.endpoint | |
Definition | The endpoint for the genomic study |
Control | 0..* |
Type | Endpoint |
20. GenomicStudy.reason[x] | |
Definition | Why the genomic study was performed |
Control | 0..* |
Type | Choice of: CodeableConcept, Reference(Condition | Observation) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
21. GenomicStudy.note | |
Definition | User-defined notes related to the genomic study |
Control | 0..* |
Type | Annotation |
22. GenomicStudy.description | |
Definition | A description of the genomic study |
Control | 0..1 |
Type | string |
23. GenomicStudy.genomicAnalysis | |
Definition | Genomic Analysis |
Control | 0..* |
Type | BackboneElement |
24. GenomicStudy.genomicAnalysis.identifier | |
Definition | Identifier(s) for the analysis |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
25. GenomicStudy.genomicAnalysis.methodType | |
Definition | Type of the method(s) used in the analysis |
Control | 0..* |
Type | CodeableConcept |
26. GenomicStudy.genomicAnalysis.protocolDefinition | |
Definition | The defined protocol that describes the analysis |
Control | 0..* |
Type | Reference(ActivityDefinition) |
27. GenomicStudy.genomicAnalysis.protocolPerformed | |
Definition | The protocol that was actually performed for the analysis |
Control | 0..* |
Type | Reference(Procedure) |
28. GenomicStudy.genomicAnalysis.performer | |
Definition | The organization, healthcare professional(s), or others who participated in performing this study |
Control | 0..* |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) |
29. GenomicStudy.genomicAnalysis.device | |
Definition | The device(s) used for the analysis (e.g., sequencers) |
Control | 0..* |
Type | Device |
30. GenomicStudy.genomicAnalysis.genomicFile | |
Definition | Genomic data file(s) used in the analysis |
Control | 0..* |
Type | Reference(DocumentReference) |
31. GenomicStudy.genomicAnalysis.genomicAssay | |
Definition | Genomic Assay |
Control | 0..* |
Type | BackboneElement |
32. GenomicStudy.genomicAnalysis.genomicAssay.identifier | |
Definition | Identifier(s) for the assay |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
33. GenomicStudy.genomicAnalysis.genomicAssay.specimen | |
Definition | The specimen used in the assay |
Control | 0..1 |
Type | Reference(Specimen) |
34. GenomicStudy.genomicAnalysis.genomicAssay.subject | |
Definition | The subject of the assay |
Control | 0..1 |
Type | Reference(Patient) |
35. GenomicStudy.genomicAnalysis.genomicAssay.date | |
Definition | The date of the assay |
Control | 0..1 |
Type | dateTime |
36. GenomicStudy.genomicAnalysis.genomicAssay.regionStudied | |
Definition | Genomic region studied by the assay |
Control | 0..1 |
Type | Reference(DocumentReference) |
37. GenomicStudy.genomicAnalysis.genomicAssay.genomicFile | |
Definition | File(s) containing genomic data generated by the assay |
Control | 0..* |
Type | Reference(DocumentReference) |