This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions
Definitions for cimi-entity-SpecimenContainer.
Basic | |
Definition | Direct container of specimen (tube/slide, etc.) |
Control | 0..* |
Alternate Names | Z-resource, Extension-resource, Custom-resource |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) 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 (: contained.where(('#'+id in %resource.descendants().reference).not()).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()) |
Basic.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 | id |
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. |
Basic.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Basic.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. |
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Basic.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
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). |
Basic.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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 This element is affected by the following invariants: dom-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 in formation is added later. |
Basic.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. |
Basic.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
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. |
Basic.extension ([CanonicalType[http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Type-extension]]) | |
Definition | The most specific code (lowest level term) describing the kind or sort of thing being represented. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Basic.extension ([CanonicalType[http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-element-Identifier-extension]]) | |
Definition | A unique string that identifies a specific person or thing. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Identifier(IdentifierProfile)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Basic.extension ([CanonicalType[http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Details-extension]]) | |
Definition | A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Basic.extension ([CanonicalType[http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Capacity-extension]]) | |
Definition | Container volume or size. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Reference(SimpleQuantity)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Basic.extension ([CanonicalType[http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecimenQuantity-extension]]) | |
Definition | Quantity of specimen within container. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Reference(SimpleQuantity)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Basic.extension ([CanonicalType[http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Additive-extension]]) | |
Definition | Additive associated with container. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: CodeableConcept, Reference(SubstanceProfile)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Basic.extension ([CanonicalType[http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SequenceNumber-extension]]) | |
Definition | The sequence number for this specimen in a collection of specimens. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Basic.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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Basic.identifier | |
Definition | Identifier assigned to the resource for business purposes, outside the context of FHIR. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Basic.code | |
Definition | Identifies the 'type' of resource - equivalent to the resource name for other resources. |
Control | 1..1 |
Binding | Codes for identifying types of resources not yet defined by FHIR For example codes, see Basic Resource Types |
Type | CodeableConcept |
Is Modifier | true |
Requirements | Must be able to distinguish different types of Basic resources. |
Comments | Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because the it defines the meaning of the resource and cannot be ignored. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/breastcancer/CodeSystem/BC-basic-resource-type"/> <code value="cimi-entity-SpecimenContainer"/> </coding> </valueCodeableConcept> |
Basic.subject | |
Definition | Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource. |
Control | 0..1 |
Type | Reference(Resource) |
Requirements | Needed for partitioning the resource by Patient. |
Comments | Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension. |
Basic.created | |
Definition | Identifies when the resource was first created. |
Control | 0..1 |
Type | date |
Requirements | Allows ordering resource instances by time. |
Basic.author | |
Definition | Indicates who was responsible for creating the resource instance. |
Control | 0..1 |
Type | Reference(Practitioner | Patient | RelatedPerson) |
Requirements | Needed for partitioning the resource. |