TrustcenterImagingStudy
The resource TrustcenterImagingStudy is a modified resource of the profile ImagingStudy and represents e.g. a set of clinical images (CT, X-ray, etc.) of a study. It consists of the elements identifier, status and subject. If a summary is requested with the command summary=true, all these elements will be displayed.
Properties and constraints
There must be at least one (1..*) identifier of type Identifier. This can and must be specialized in this case by specifying exactly one (1..1) officialIdentifier (fixed values: use = official). However, other identifiers can be defined, e.g. with the use usual, temp, secondary or old. In addition, the officialIdentifier is marked as must support therefore the later implementation should be able to process this meaningfully.
The attributes status or subject of type code or Reference (data type that references an existing resource, such as patient), respectively, are already stipulated by the super resource and must be specified exactly once. The first specifies the status of the study and its values must come from a specific value set (binding-strength = required). Here, they come from the set imagingstudy-status. The latter specifies what the study refers to (often a patient). The instance can be specified in different ways, e.g. as reference, type or identifier.
| TrustcenterImagingStudy (ImagingStudy) | I | ImagingStudy | There are no (further) constraints on this element Element idImagingStudy A set of images produced in single study (one or more series of references images) DefinitionRepresentation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
| |
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idImagingStudy.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idImagingStudy.meta Metadata about the resource DefinitionThe 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.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idImagingStudy.implicitRules A set of rules under which this content was created DefinitionA 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idImagingStudy.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idImagingStudy.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idImagingStudy.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. 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.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImagingStudy.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idImagingStudy.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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.
|
| identifier | Σ | 1..* | Identifier | Element idImagingStudy.identifier Identifiers for the whole study Alternate namesStudyInstanceUID, AccessionNumber DefinitionIdentifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. If one or more series elements are present in the ImagingStudy, then there shall be one DICOM Study UID identifier (see DICOM PS 3.3 C.7.2. See discussion under Imaging Study Implementation Notes for encoding of DICOM Study Instance UID. Accession Number should use ACSN Identifier type. Unordered, Open, by use(Value) Constraints
|
| officialIdentifier | S Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idImagingStudy.identifier:officialIdentifier Identifiers for the whole study Alternate namesStudyInstanceUID, AccessionNumber DefinitionIdentifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. If one or more series elements are present in the ImagingStudy, then there shall be one DICOM Study UID identifier (see DICOM PS 3.3 C.7.2. See discussion under Imaging Study Implementation Notes for encoding of DICOM Study Instance UID. Accession Number should use ACSN Identifier type.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idImagingStudy.identifier:officialIdentifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImagingStudy.identifier:officialIdentifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element idImagingStudy.identifier:officialIdentifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
official
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idImagingStudy.identifier:officialIdentifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idImagingStudy.identifier:officialIdentifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idImagingStudy.identifier:officialIdentifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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 Rendered Value extension. 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.
General 123456 Mappings
|
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idImagingStudy.identifier:officialIdentifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
|
| assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idImagingStudy.identifier:officialIdentifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idImagingStudy.status registered | available | cancelled | entered-in-error | unknown DefinitionThe current state of the ImagingStudy. 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. The status of the ImagingStudy.
|
| modality | Σ | 0..0 | CodingBinding | There are no (further) constraints on this element Element idImagingStudy.modality All series modality if actual acquisition modalities Alternate namesModalitiesInStudy DefinitionA list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). Type of acquired data in the instance.
|
| subject | Σ | 1..1 | Reference(Patient | Device | Group) | There are no (further) constraints on this element Element idImagingStudy.subject Who or what is the subject of the study DefinitionThe subject, typically a patient, of the imaging study. QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group. Reference(Patient | Device | Group) Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idImagingStudy.subject.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImagingStudy.subject.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element idImagingStudy.subject.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idImagingStudy.subject.type Type the reference refers to (e.g. "Patient") DefinitionThe 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). 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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idImagingStudy.subject.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
|
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idImagingStudy.subject.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
| encounter | Σ | 0..0 | Reference(Encounter) | There are no (further) constraints on this element Element idImagingStudy.encounter Encounter with which this imaging study is associated DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission test).
|
| started | Σ | 0..0 | dateTime | There are no (further) constraints on this element Element idImagingStudy.started When the study was started Alternate namesStudyDate, StudyTime DefinitionDate and time the study started.
General 2011-01-01T11:01:20+03:00 Mappings
|
| basedOn | Σ | 0..0 | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | There are no (further) constraints on this element Element idImagingStudy.basedOn Request fulfilled DefinitionA list of the diagnostic requests that resulted in this imaging study being performed. To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT). Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Constraints
|
| referrer | Σ | 0..0 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idImagingStudy.referrer Referring physician Alternate namesReferringPhysiciansName DefinitionThe requesting/referring physician. Reference(Practitioner | PractitionerRole) Constraints
|
| interpreter | Σ | 0..0 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idImagingStudy.interpreter Who interpreted images Alternate namesName of Physician(s) Reading Study DefinitionWho read the study and interpreted the images or other content. Reference(Practitioner | PractitionerRole) Constraints
|
| endpoint | Σ | 0..0 | Reference(Endpoint) | There are no (further) constraints on this element Element idImagingStudy.endpoint Study access endpoint DefinitionThe network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType. Access methods for viewing (e.g., IHE’s IID profile) or retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the study or the study’s series or instances. The study-level baseLocation applies to each series in the study, unless overridden in series by a series-level baseLocation of the same type. 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; DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer.
|
| numberOfSeries | Σ | 0..0 | unsignedInt | There are no (further) constraints on this element Element idImagingStudy.numberOfSeries Number of Study Related Series Alternate namesNumberOfStudyRelatedSeries DefinitionNumber of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
|
| numberOfInstances | Σ | 0..0 | unsignedInt | There are no (further) constraints on this element Element idImagingStudy.numberOfInstances Number of Study Related Instances Alternate namesNumberOfStudyRelatedInstances DefinitionNumber of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
|
| procedureReference | Σ | 0..0 | Reference(Procedure) | There are no (further) constraints on this element Element idImagingStudy.procedureReference The performed Procedure reference DefinitionThe procedure which this ImagingStudy was part of.
|
| procedureCode | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idImagingStudy.procedureCode The performed procedure code Alternate namesProcedureCodeSequence DefinitionThe code for the performed procedure type. The performed procedure type.
|
| location | Σ | 0..0 | Reference(Location) | There are no (further) constraints on this element Element idImagingStudy.location Where ImagingStudy occurred DefinitionThe principal physical location where the ImagingStudy was performed. Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).
|
| reasonCode | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idImagingStudy.reasonCode Why the study was requested DefinitionDescription of clinical condition indicating why the ImagingStudy was requested. The reason for the study.
|
| reasonReference | Σ | 0..0 | Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idImagingStudy.reasonReference Why was study performed DefinitionIndicates another resource whose existence justifies this Study. Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) Constraints
|
| note | Σ | 0..0 | Annotation | There are no (further) constraints on this element Element idImagingStudy.note User-defined comments DefinitionPer the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.
|
| description | Σ | 0..0 | string | There are no (further) constraints on this element Element idImagingStudy.description Institution-generated description Alternate namesStudyDescription DefinitionThe Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
|
| series | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idImagingStudy.series Each study has one or more series of instances DefinitionEach study has one or more series of images or other content.
|