DICOM SR to FHIR Resource Mapping IG, published by HL7 Imaging Integration Working Group. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/dicom-sr/ and changes regularly. See the Directory of published versions
| Draft as of 2023-06-13 |
Definitions for the image-region-2d resource profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. ImagingSelection | |
| 2. ImagingSelection.subject | |
| Control | 10..1 |
| Type | Reference(Patient|Group|Device|Location|Organization|Procedure|Practitioner|Medication|Substance|Specimen) |
| Must Support | true |
| 3. ImagingSelection.basedOn | |
| Slicing | This element introduces a set of slices on ImagingSelection.basedOn. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. ImagingSelection.basedOn:serviceRequestRef | |
| SliceName | serviceRequestRef |
| Control | 0..1 |
| Type | Reference(ServiceRequest) |
| Must Support | true |
| 5. ImagingSelection.basedOn:serviceRequestRef.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..? |
| 6. ImagingSelection.basedOn:serviceRequestRef.identifier.type | |
| Control | 1..? |
| Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/> <code value="ACSN"/> <display value="Accession ID"/> </coding> </valueCodeableConcept> |
| 7. ImagingSelection.basedOn:serviceRequestRef.identifier.value | |
| Control | 1..? |
| 8. ImagingSelection.code | |
| Must Support | true |
| 9. ImagingSelection.code.coding | |
| Control | 0..? |
| Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://dicom.nema.org/resources/ontology/DCM"/> <code value="111030"/> <display value="Image Region"/> </valueCoding> |
| 10. ImagingSelection.derivedFrom | |
| Control | 10..* |
| Slicing | This element introduces a set of slices on ImagingSelection.derivedFrom. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 11. ImagingSelection.derivedFrom:imagingStudyRef | |
| SliceName | imagingStudyRef |
| Control | 1..1 |
| Type | Reference(ImagingStudy) |
| Must Support | true |
| 12. ImagingSelection.derivedFrom:imagingStudyRef.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..? |
| 13. ImagingSelection.derivedFrom:imagingStudyRef.identifier.type | |
| Control | 1..? |
| Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/uv/dicom-sr/CodeSystem/dicom-identifier-type"/> <code value="study-instance-uid"/> <display value="Study Instance UID"/> </coding> </valueCodeableConcept> |
| 14. ImagingSelection.derivedFrom:imagingStudyRef.identifier.system | |
| Control | 0..? |
| Pattern Value | urn:dicom:uid |
| 15. ImagingSelection.derivedFrom:imagingStudyRef.identifier.value | |
| Control | 1..? |
| 16. ImagingSelection.instance | |
| Slicing | This element introduces a set of slices on ImagingSelection.instance. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 17. ImagingSelection.instance:imageInstance | |
| SliceName | imageInstance |
| Control | 0..* |
| 18. ImagingSelection.instance:imageInstance.uid | |
| Control | 0..? |
| 19. ImagingSelection.instance:imageInstance.imageRegion2D | |
| Control | 1..1 |
| Must Support | true |
| 20. ImagingSelection.instance:imageInstance.imageRegion2D.regionType | |
| Control | 0..? |
| 21. ImagingSelection.instance:imageInstance.imageRegion2D.coordinate | |
| Control | 0..? |
Guidance on how to interpret the contents of this table can be found here.
| 1. ImagingSelection | |
| Definition | A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource. |
| Control | 0..* |
| Summary | false |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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. ImagingSelection.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 |
| Summary | 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 its 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())) |
| 3. ImagingSelection.contained | |
| Definition | 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Summary | false |
| 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. |
| 4. ImagingSelection.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 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. 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 |
| Summary | 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()) |
| 5. ImagingSelection.status | |
| Definition | The current state of the ImagingSelection resource. This is not the status of any ImagingStudy, ServiceRequest, or Task resources associated with the ImagingSelection. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ImagingSelectionStatus The status of the ImagingSelection. |
| Type | code |
| Is Modifier | true |
| Summary | true |
| Comments | Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 6. ImagingSelection.subject | |
| Definition | The patient, or group of patients, location, device, organization, procedure or practitioner this imaging selection is about and into whose or what record the imaging selection is placed. |
| Control | 10..1 |
| Type | Reference(Patient|Group|Device|Location|Organization|Procedure|Practitioner|Medication|Substance|Specimen) |
| Must Support | true |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 7. ImagingSelection.basedOn | |
| Definition | A list of the diagnostic requests that resulted in this imaging selection being performed. |
| Control | 0..* |
| Type | Reference(CarePlan|ServiceRequest|Appointment|AppointmentResponse|Task) |
| Summary | true |
| Alternate Names | AccessionNumber |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on ImagingSelection.basedOn. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 8. ImagingSelection.basedOn:serviceRequestRef | |
| SliceName | serviceRequestRef |
| Definition | A list of the diagnostic requests that resulted in this imaging selection being performed. |
| Control | 0..1* |
| Type | Reference(ServiceRequest|CarePlan|Appointment|AppointmentResponse|Task) |
| Must Support | true |
| Summary | true |
| Alternate Names | AccessionNumber |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 9. ImagingSelection.basedOn:serviceRequestRef.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Summary | true |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 10. ImagingSelection.basedOn:serviceRequestRef.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Summary | true |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. ImagingSelection.basedOn:serviceRequestRef.identifier.use | |
| Definition | The purpose of this identifier. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 12. ImagingSelection.basedOn:serviceRequestRef.identifier.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from IdentifierTypeCodes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/> <code value="ACSN"/> <display value="Accession ID"/> </coding> </valueCodeableConcept> |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 13. ImagingSelection.basedOn:serviceRequestRef.identifier.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Control | 10..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Summary | true |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Example | General:123456 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 14. ImagingSelection.code | |
| Definition | Reason for referencing the selected content. |
| Control | 1..1 |
| Binding | For example codes, see KeyObjectSelectionDocumentTitle Key Object Selection Document Title. |
| Type | CodeableConcept |
| Must Support | true |
| Summary | true |
| Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
| Alternate Names | Description |
| Comments | All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 15. ImagingSelection.code.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Control | 0..* |
| Type | Coding |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://dicom.nema.org/resources/ontology/DCM"/> <code value="111030"/> <display value="Image Region"/> </valueCoding> |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 16. ImagingSelection.derivedFrom | |
| Definition | The imaging study from which the imaging selection is made. |
| Control | 10..* |
| Type | Reference(ImagingStudy|DocumentReference) |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on ImagingSelection.derivedFrom. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 17. ImagingSelection.derivedFrom:imagingStudyRef | |
| SliceName | imagingStudyRef |
| Definition | The imaging study from which the imaging selection is made. |
| Control | 10..1* |
| Type | Reference(ImagingStudy|DocumentReference) |
| Must Support | true |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 18. ImagingSelection.derivedFrom:imagingStudyRef.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Summary | true |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 19. ImagingSelection.derivedFrom:imagingStudyRef.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Summary | true |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 20. ImagingSelection.derivedFrom:imagingStudyRef.identifier.use | |
| Definition | The purpose of this identifier. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 21. ImagingSelection.derivedFrom:imagingStudyRef.identifier.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from IdentifierTypeCodes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/uv/dicom-sr/CodeSystem/dicom-identifier-type"/> <code value="study-instance-uid"/> <display value="Study Instance UID"/> </coding> </valueCodeableConcept> |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 22. ImagingSelection.derivedFrom:imagingStudyRef.identifier.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Control | 0..1 |
| Type | uri |
| Summary | true |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Pattern Value | urn:dicom:uid |
| Example | General:http://www.acme.com/identifiers/patient |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 23. ImagingSelection.derivedFrom:imagingStudyRef.identifier.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Control | 10..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Summary | true |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Example | General:123456 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 24. ImagingSelection.instance | |
| Definition | Each imaging selection includes one or more selected DICOM SOP instances. |
| Control | 0..* |
| Type | BackboneElement |
| Summary | true |
| Requirements | Required if the the selection does not include all instances in the specified series. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on ImagingSelection.instance. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 25. ImagingSelection.instance.modifierExtension | |
| Definition | 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's 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. 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 |
| Summary | 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, modifiers |
| 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()) |
| 26. ImagingSelection.instance.uid | |
| Definition | The SOP Instance UID for the selected DICOM instance. |
| Control | 1..1 |
| Type | id |
| Summary | true |
| Requirements | DICOM SOP Instance UID. |
| Alternate Names | SOPInstanceUID |
| Comments | See DICOM PS3.3 C.12.1. |
| Example | General:1.2.840.113747.20080222.12753225430534207568475333748793.1.1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 27. ImagingSelection.instance:imageInstance | |
| SliceName | imageInstance |
| Definition | Each imaging selection includes one or more selected DICOM SOP instances. |
| Control | 0..* |
| Type | BackboneElement |
| Summary | true |
| Requirements | Required if the the selection does not include all instances in the specified series. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 28. ImagingSelection.instance:imageInstance.modifierExtension | |
| Definition | 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's 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. 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 |
| Summary | 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, modifiers |
| 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()) |
| 29. ImagingSelection.instance:imageInstance.uid | |
| Definition | The SOP Instance UID for the selected DICOM instance. |
| Control | 1..1 |
| Type | id |
| Summary | true |
| Requirements | DICOM SOP Instance UID. |
| Alternate Names | SOPInstanceUID |
| Comments | See DICOM PS3.3 C.12.1. |
| Example | General:1.2.840.113747.20080222.12753225430534207568475333748793.1.1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 30. ImagingSelection.instance:imageInstance.imageRegion2D | |
| Definition | Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list. |
| Control | 10..1* |
| Type | BackboneElement |
| Must Support | true |
| Summary | false |
| Requirements | Shall not be present if the parent imagingSelection.instance is not an image. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 31. ImagingSelection.instance:imageInstance.imageRegion2D.modifierExtension | |
| Definition | 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's 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. 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 |
| Summary | 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, modifiers |
| 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()) |
| 32. ImagingSelection.instance:imageInstance.imageRegion2D.regionType | |
| Definition | Specifies the type of image region. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ImagingSelection2DGraphicType The type of image region. |
| Type | code |
| Summary | false |
| Alternate Names | GraphicType |
| Comments | |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 33. ImagingSelection.instance:imageInstance.imageRegion2D.coordinate | |
| Definition | The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution. The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames. |
| Control | 1..* |
| Type | decimal |
| Summary | false |
| Requirements | The number of values must be a multiple of two. |
| Alternate Names | GraphicData |
| Comments | For a description of how 2D coordinates are encoded, see DICOM PS3.3 C.18.6. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
| 1. ImagingSelection | |
| Definition | A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource. |
| Control | 0..* |
| Summary | false |
| 2. ImagingSelection.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 |
| Summary | true |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| 3. ImagingSelection.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 |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 4. ImagingSelection.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 |
| Summary | 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 its 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. ImagingSelection.language | |
| Definition | The base language in which the resource is written. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages IETF language tag for a human languag |
| Type | code |
| Summary | false |
| 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. ImagingSelection.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 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Comments | Contained resources do not have a 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. ImagingSelection.contained | |
| Definition | 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Summary | false |
| 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. ImagingSelection.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 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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()) |
| 9. ImagingSelection.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 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. 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 |
| Summary | 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()) |
| 10. ImagingSelection.identifier | |
| Definition | A unique identifier assigned to this imaging selection. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Summary | true |
| Requirements | Allows imaging selections to be distinguished and referenced. |
| Comments | This is a business identifier, not a resource identifier -- see discussion under Business Identifiers. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. ImagingSelection.status | |
| Definition | The current state of the ImagingSelection resource. This is not the status of any ImagingStudy, ServiceRequest, or Task resources associated with the ImagingSelection. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ImagingSelectionStatus The status of the ImagingSelection |
| Type | code |
| Is Modifier | true |
| Summary | true |
| Comments | Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 12. ImagingSelection.subject | |
| Definition | The patient, or group of patients, location, device, organization, procedure or practitioner this imaging selection is about and into whose or what record the imaging selection is placed. |
| Control | 1..1 |
| Type | Reference(Patient) |
| Must Support | true |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 13. ImagingSelection.issued | |
| Definition | The date and time this imaging selection was created. |
| Control | 0..1 |
| Type | instant |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 14. ImagingSelection.performer | |
| Definition | Selector of the instances – human or machine. |
| Control | 0..* |
| Type | BackboneElement |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 15. ImagingSelection.performer.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 16. ImagingSelection.performer.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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()) |
| 17. ImagingSelection.performer.modifierExtension | |
| Definition | 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's 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. 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 |
| Summary | 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, modifiers |
| 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()) |
| 18. ImagingSelection.performer.function | |
| Definition | Distinguishes the type of involvement of the performer. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ImagingStudySeriesPerformerFunction; other codes may be used where these codes are not suitable The type of involvement of the performer |
| Type | CodeableConcept |
| Summary | true |
| Requirements | Allows disambiguation of the types and involvement of different performers. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 19. ImagingSelection.performer.actor | |
| Definition | Author – human or machine. |
| Control | 0..1 |
| Type | Reference(Practitioner|PractitionerRole|Device|Organization|CareTeam|Patient|RelatedPerson|HealthcareService) |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 20. ImagingSelection.basedOn | |
| Definition | A list of the diagnostic requests that resulted in this imaging selection being performed. |
| Control | 0..* |
| Type | Reference(CarePlan|ServiceRequest|Appointment|AppointmentResponse|Task) |
| Summary | true |
| Alternate Names | AccessionNumber |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on ImagingSelection.basedOn. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 21. ImagingSelection.basedOn:serviceRequestRef | |
| SliceName | serviceRequestRef |
| Definition | A list of the diagnostic requests that resulted in this imaging selection being performed. |
| Control | 0..1 |
| Type | Reference(ServiceRequest) |
| Must Support | true |
| Summary | true |
| Alternate Names | AccessionNumber |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 22. ImagingSelection.basedOn:serviceRequestRef.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 23. ImagingSelection.basedOn:serviceRequestRef.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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 ImagingSelection.basedOn.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 24. ImagingSelection.basedOn:serviceRequestRef.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Summary | true |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 25. ImagingSelection.basedOn:serviceRequestRef.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model) |
| Type | uri |
| Summary | true |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 26. ImagingSelection.basedOn:serviceRequestRef.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Summary | true |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 27. ImagingSelection.basedOn:serviceRequestRef.identifier.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 28. ImagingSelection.basedOn:serviceRequestRef.identifier.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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 ImagingSelection.basedOn.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 29. ImagingSelection.basedOn:serviceRequestRef.identifier.use | |
| Definition | The purpose of this identifier. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known |
| Type | code |
| Is Modifier | true |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 30. ImagingSelection.basedOn:serviceRequestRef.identifier.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IdentifierTypeCodes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose |
| Type | CodeableConcept |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/> <code value="ACSN"/> <display value="Accession ID"/> </coding> </valueCodeableConcept> |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 31. ImagingSelection.basedOn:serviceRequestRef.identifier.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Control | 0..1 |
| Type | uri |
| Summary | true |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Example | General:http://www.acme.com/identifiers/patient |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 32. ImagingSelection.basedOn:serviceRequestRef.identifier.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Summary | true |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Example | General:123456 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 33. ImagingSelection.basedOn:serviceRequestRef.identifier.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Control | 0..1 |
| Type | Period |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 34. ImagingSelection.basedOn:serviceRequestRef.identifier.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Summary | true |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 35. ImagingSelection.basedOn:serviceRequestRef.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Summary | true |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 36. ImagingSelection.category | |
| Definition | Classifies the imaging selection. |
| Control | 0..* |
| Binding | For example codes, see KeyObjectSelectionDocumentTitle Key Object Selection Document Title |
| Type | CodeableConcept |
| Summary | true |
| Requirements | Used for filtering what imaging selections are retrieved and displayed. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 37. ImagingSelection.code | |
| Definition | Reason for referencing the selected content. |
| Control | 1..1 |
| Binding | For example codes, see KeyObjectSelectionDocumentTitle Key Object Selection Document Title |
| Type | CodeableConcept |
| Must Support | true |
| Summary | true |
| Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
| Alternate Names | Description |
| Comments | All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 38. ImagingSelection.code.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 39. ImagingSelection.code.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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 ImagingSelection.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 40. ImagingSelection.code.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Control | 0..* |
| Type | Coding |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://dicom.nema.org/resources/ontology/DCM"/> <code value="111030"/> <display value="Image Region"/> </valueCoding> |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 41. ImagingSelection.code.text | |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Control | 0..1 |
| Type | string |
| Summary | true |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 42. ImagingSelection.studyUid | |
| Definition | The Study Instance UID for the DICOM Study from which the images were selected. |
| Control | 0..1 |
| Type | id |
| Summary | true |
| Requirements | DICOM Study Instance UID. Required unless frameOfReferenceUid and imageRegion are present and instance is not present. |
| Alternate Names | StudyInstanceUID |
| Comments | See DICOM PS3.3 C.7.2. |
| Example | General:1.2.840.113747.20080222.12753225430534207565993148475333748793 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 43. ImagingSelection.derivedFrom | |
| Definition | The imaging study from which the imaging selection is made. |
| Control | 1..* |
| Type | Reference(ImagingStudy|DocumentReference) |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on ImagingSelection.derivedFrom. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 44. ImagingSelection.derivedFrom:imagingStudyRef | |
| SliceName | imagingStudyRef |
| Definition | The imaging study from which the imaging selection is made. |
| Control | 1..1 |
| Type | Reference(ImagingStudy) |
| Must Support | true |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 45. ImagingSelection.derivedFrom:imagingStudyRef.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 46. ImagingSelection.derivedFrom:imagingStudyRef.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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 ImagingSelection.derivedFrom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 47. ImagingSelection.derivedFrom:imagingStudyRef.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Summary | true |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 48. ImagingSelection.derivedFrom:imagingStudyRef.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model) |
| Type | uri |
| Summary | true |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 49. ImagingSelection.derivedFrom:imagingStudyRef.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Summary | true |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 50. ImagingSelection.derivedFrom:imagingStudyRef.identifier.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 51. ImagingSelection.derivedFrom:imagingStudyRef.identifier.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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 ImagingSelection.derivedFrom.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 52. ImagingSelection.derivedFrom:imagingStudyRef.identifier.use | |
| Definition | The purpose of this identifier. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known |
| Type | code |
| Is Modifier | true |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 53. ImagingSelection.derivedFrom:imagingStudyRef.identifier.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IdentifierTypeCodes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose |
| Type | CodeableConcept |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/uv/dicom-sr/CodeSystem/dicom-identifier-type"/> <code value="study-instance-uid"/> <display value="Study Instance UID"/> </coding> </valueCodeableConcept> |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 54. ImagingSelection.derivedFrom:imagingStudyRef.identifier.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Control | 0..1 |
| Type | uri |
| Summary | true |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Pattern Value | urn:dicom:uid |
| Example | General:http://www.acme.com/identifiers/patient |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 55. ImagingSelection.derivedFrom:imagingStudyRef.identifier.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Summary | true |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Example | General:123456 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 56. ImagingSelection.derivedFrom:imagingStudyRef.identifier.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Control | 0..1 |
| Type | Period |
| Summary | true |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 57. ImagingSelection.derivedFrom:imagingStudyRef.identifier.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Summary | true |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 58. ImagingSelection.derivedFrom:imagingStudyRef.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Summary | true |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 59. ImagingSelection.endpoint | |
| Definition | The network service providing retrieval access to the selected images, frames, etc. See implementation notes for information about using DICOM endpoints. |
| Control | 0..* |
| Type | Reference(Endpoint) |
| Summary | true |
| Requirements | Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the selected images, frames, etc. |
| Comments | Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG) formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 60. ImagingSelection.seriesUid | |
| Definition | The Series Instance UID for the DICOM Series from which the images were selected. |
| Control | 0..1 |
| Type | id |
| Summary | true |
| Requirements | DICOM Series Instance UID. Required unless frameOfReferenceUid and imageRegion are present and instance is not present. |
| Alternate Names | SeriesInstanceUID |
| Comments | See DICOM PS3.3 C.7.3. |
| Example | General:1.2.840.113747.20080222.12753225430534207565993148475333748793.1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 61. ImagingSelection.seriesNumber | |
| Definition | The Series Number for the DICOM Series from which the images were selected. |
| Control | 0..1 |
| Type | unsignedInt |
| Summary | true |
| Requirements | DICOM Series Number. |
| Alternate Names | SeriesNumber |
| Comments | See DICOM PS3.3 C.7.3. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 62. ImagingSelection.frameOfReferenceUid | |
| Definition | The Frame of Reference UID identifying the coordinate system that conveys spatial and/or temporal information for the selected images or frames. |
| Control | 0..1 |
| Type | id |
| Summary | true |
| Requirements | DICOM Frame of Reference UID. Required if studyInstanceUid and seriesInstanceUid are not present. |
| Alternate Names | FrameOfReferenceUID |
| Comments | See DICOM PS3.3 C.7.4.1. |
| Example | General:1.2.840.113747.20080222.12753225430534207565993148475333748793.2 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 63. ImagingSelection.bodySite | |
| Definition | The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. |
| Control | 0..1 |
| Binding | For example codes, see SNOMEDCTBodyStructures SNOMED CT Body site concept |
| Type | CodeableReference(BodyStructure) |
| Summary | true |
| Alternate Names | BodyPartExamined |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 64. ImagingSelection.focus | |
| Definition | The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
| Control | 0..* |
| Type | Reference(ImagingSelection) |
| Summary | true |
| Comments | An imaging selection may reference a DICOM resource that itself references other DICOM resources. e.g. a presentation state references a set of source images or frames. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 65. ImagingSelection.instance | |
| Definition | Each imaging selection includes one or more selected DICOM SOP instances. |
| Control | 0..* |
| Type | BackboneElement |
| Summary | true |
| Requirements | Required if the the selection does not include all instances in the specified series. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on ImagingSelection.instance. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 66. ImagingSelection.instance.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 67. ImagingSelection.instance.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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()) |
| 68. ImagingSelection.instance.modifierExtension | |
| Definition | 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's 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. 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 |
| Summary | 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, modifiers |
| 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()) |
| 69. ImagingSelection.instance.uid | |
| Definition | The SOP Instance UID for the selected DICOM instance. |
| Control | 1..1 |
| Type | id |
| Summary | true |
| Requirements | DICOM SOP Instance UID. |
| Alternate Names | SOPInstanceUID |
| Comments | See DICOM PS3.3 C.12.1. |
| Example | General:1.2.840.113747.20080222.12753225430534207568475333748793.1.1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 70. ImagingSelection.instance.number | |
| Definition | The Instance Number for the selected DICOM instance. |
| Control | 0..1 |
| Type | unsignedInt |
| Summary | true |
| Requirements | DICOM Instance Number. |
| Alternate Names | InstanceNumber |
| Comments | See DICOM PS3.3 C.7.6.1. Note: A multiframe instance has a single instance number with each frame identified by a frame number. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 71. ImagingSelection.instance.sopClass | |
| Definition | The SOP Class UID for the selected DICOM instance. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1; other codes may be used where these codes are not suitable DICOM SOP Classes |
| Type | Coding |
| Summary | false |
| Requirements | DICOM SOP Class UID. |
| Alternate Names | SOPClassUID |
| Comments | See DICOM PS3.3 C.12.1. |
| Example | General:1.2.840.10008.5.1.4.1.1.2 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 72. ImagingSelection.instance.subset | |
| Definition | Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance. |
| Control | 0..* |
| Type | string |
| Summary | false |
| Example | General:6 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 73. ImagingSelection.instance.imageRegion2D | |
| Definition | Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list. |
| Control | 0..* |
| Type | BackboneElement |
| Summary | false |
| Requirements | Shall not be present if the parent imagingSelection.instance is not an image. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 74. ImagingSelection.instance.imageRegion2D.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 75. ImagingSelection.instance.imageRegion2D.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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()) |
| 76. ImagingSelection.instance.imageRegion2D.modifierExtension | |
| Definition | 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's 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. 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 |
| Summary | 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, modifiers |
| 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()) |
| 77. ImagingSelection.instance.imageRegion2D.regionType | |
| Definition | Specifies the type of image region. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ImagingSelection2DGraphicType The type of image region |
| Type | code |
| Summary | false |
| Alternate Names | GraphicType |
| Comments | |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 78. ImagingSelection.instance.imageRegion2D.coordinate | |
| Definition | The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution. The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames. |
| Control | 1..* |
| Type | decimal |
| Summary | false |
| Requirements | The number of values must be a multiple of two. |
| Alternate Names | GraphicData |
| Comments | For a description of how 2D coordinates are encoded, see DICOM PS3.3 C.18.6. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 79. ImagingSelection.instance.imageRegion3D | |
| Definition | Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates. |
| Control | 0..* |
| Type | BackboneElement |
| Summary | false |
| Requirements | Requires that the ImagingSelection.frameOfReferenceUid element is present. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 80. ImagingSelection.instance.imageRegion3D.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 81. ImagingSelection.instance.imageRegion3D.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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()) |
| 82. ImagingSelection.instance.imageRegion3D.modifierExtension | |
| Definition | 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's 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. 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 |
| Summary | 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, modifiers |
| 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()) |
| 83. ImagingSelection.instance.imageRegion3D.regionType | |
| Definition | Specifies the type of image region. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ImagingSelection3DGraphicType The type of image region |
| Type | code |
| Summary | false |
| Alternate Names | GraphicType |
| Comments | |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 84. ImagingSelection.instance.imageRegion3D.coordinate | |
| Definition | The coordinates describing the image region. Encoded as an ordered set of (x,y,z) triplets (in mm and may be negative) that define a region of interest in the patient-relative Reference Coordinate System defined by ImagingSelection.frameOfReferenceUid element. |
| Control | 1..* |
| Type | decimal |
| Summary | false |
| Requirements | The number of values must be a multiple of three. |
| Alternate Names | GraphicData |
| Comments | For a description of how 3D coordinates are encoded, see DICOM PS3.3 C.18.9. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 85. ImagingSelection.instance:imageInstance | |
| SliceName | imageInstance |
| Definition | Each imaging selection includes one or more selected DICOM SOP instances. |
| Control | 0..* |
| Type | BackboneElement |
| Summary | true |
| Requirements | Required if the the selection does not include all instances in the specified series. |
| 86. ImagingSelection.instance:imageInstance.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 87. ImagingSelection.instance:imageInstance.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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()) |
| 88. ImagingSelection.instance:imageInstance.modifierExtension | |
| Definition | 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's 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. 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 |
| Summary | 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, modifiers |
| 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()) |
| 89. ImagingSelection.instance:imageInstance.uid | |
| Definition | The SOP Instance UID for the selected DICOM instance. |
| Control | 1..1 |
| Type | id |
| Summary | true |
| Requirements | DICOM SOP Instance UID. |
| Alternate Names | SOPInstanceUID |
| Comments | See DICOM PS3.3 C.12.1. |
| Example | General:1.2.840.113747.20080222.12753225430534207568475333748793.1.1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 90. ImagingSelection.instance:imageInstance.number | |
| Definition | The Instance Number for the selected DICOM instance. |
| Control | 0..1 |
| Type | unsignedInt |
| Summary | true |
| Requirements | DICOM Instance Number. |
| Alternate Names | InstanceNumber |
| Comments | See DICOM PS3.3 C.7.6.1. Note: A multiframe instance has a single instance number with each frame identified by a frame number. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 91. ImagingSelection.instance:imageInstance.sopClass | |
| Definition | The SOP Class UID for the selected DICOM instance. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1; other codes may be used where these codes are not suitable DICOM SOP Classes |
| Type | Coding |
| Summary | false |
| Requirements | DICOM SOP Class UID. |
| Alternate Names | SOPClassUID |
| Comments | See DICOM PS3.3 C.12.1. |
| Example | General:1.2.840.10008.5.1.4.1.1.2 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 92. ImagingSelection.instance:imageInstance.subset | |
| Definition | Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance. |
| Control | 0..* |
| Type | string |
| Summary | false |
| Example | General:6 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 93. ImagingSelection.instance:imageInstance.imageRegion2D | |
| Definition | Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list. |
| Control | 1..1 |
| Type | BackboneElement |
| Must Support | true |
| Summary | false |
| Requirements | Shall not be present if the parent imagingSelection.instance is not an image. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 94. ImagingSelection.instance:imageInstance.imageRegion2D.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 95. ImagingSelection.instance:imageInstance.imageRegion2D.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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()) |
| 96. ImagingSelection.instance:imageInstance.imageRegion2D.modifierExtension | |
| Definition | 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's 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. 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 |
| Summary | 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, modifiers |
| 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()) |
| 97. ImagingSelection.instance:imageInstance.imageRegion2D.regionType | |
| Definition | Specifies the type of image region. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ImagingSelection2DGraphicType The type of image region |
| Type | code |
| Summary | false |
| Alternate Names | GraphicType |
| Comments | |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 98. ImagingSelection.instance:imageInstance.imageRegion2D.coordinate | |
| Definition | The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution. The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames. |
| Control | 1..* |
| Type | decimal |
| Summary | false |
| Requirements | The number of values must be a multiple of two. |
| Alternate Names | GraphicData |
| Comments | For a description of how 2D coordinates are encoded, see DICOM PS3.3 C.18.6. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 99. ImagingSelection.instance:imageInstance.imageRegion3D | |
| Definition | Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates. |
| Control | 0..* |
| Type | BackboneElement |
| Summary | false |
| Requirements | Requires that the ImagingSelection.frameOfReferenceUid element is present. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 100. ImagingSelection.instance:imageInstance.imageRegion3D.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 101. ImagingSelection.instance:imageInstance.imageRegion3D.extension | |
| Definition | 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. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| 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()) |
| 102. ImagingSelection.instance:imageInstance.imageRegion3D.modifierExtension | |
| Definition | 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's 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. 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 |
| Summary | 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, modifiers |
| 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()) |
| 103. ImagingSelection.instance:imageInstance.imageRegion3D.regionType | |
| Definition | Specifies the type of image region. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ImagingSelection3DGraphicType The type of image region |
| Type | code |
| Summary | false |
| Alternate Names | GraphicType |
| Comments | |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 104. ImagingSelection.instance:imageInstance.imageRegion3D.coordinate | |
| Definition | The coordinates describing the image region. Encoded as an ordered set of (x,y,z) triplets (in mm and may be negative) that define a region of interest in the patient-relative Reference Coordinate System defined by ImagingSelection.frameOfReferenceUid element. |
| Control | 1..* |
| Type | decimal |
| Summary | false |
| Requirements | The number of values must be a multiple of three. |
| Alternate Names | GraphicData |
| Comments | For a description of how 3D coordinates are encoded, see DICOM PS3.3 C.18.9. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |