| ImagingStudy | I | | ImagingStudy | There are no (further) constraints on this element Element IdShort description A set of images produced in single study (one or more series of references images) Definition Representation 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.
ImagingStudy Constraints- dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6:A resource should have narrative for robust management
text.`div`.exists() - dom-5:If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
- rim:Entity. Role, or Act
- workflow:Event
- rim:Act[classCode=COMPOSITION, moodCode=EVN]
- dicom:Reference IHE radiology TF vol 2 table 4.14-1
|
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdShort description Identifiers for the whole study Alternate names StudyInstanceUID, AccessionNumber Definition Identifiers 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.
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- workflow:Event.identifier
- w5:FiveWs.identifier
- rim:.id and .inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id
- dicom:StudyInstanceUID (0020,000D) | Accession Number and Issuer (0080,0050)+(0080,0051) | Study ID (0020,0010)
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdShort description registered | available | cancelled | entered-in-error | unknown Definition The 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.
code Binding The status of the ImagingStudy. ImagingStudyStatus (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- workflow:Event.status
- w5:FiveWs.status
- v2:Varies by domain
- rim:.status
|
| modality | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdShort description All series modality if actual acquisition modalities Alternate names ModalitiesInStudy Definition A 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).
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.
Coding Binding Type of acquired data in the instance. http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- w5:FiveWs.class
- rim:.code
- dicom:(0008,0061)
|
| subject | Σ I | 1..1 | Reference(Group | UK Core Device | UK Core Patient) | Element IdShort description Who or what is the subject of the study Definition The 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(Group | UK Core Device | UK Core Patient) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:Event.subject
- w5:FiveWs.subject[x]
- rim:.participation[typeCode=SBJ].role
- dicom:(0010/*)
- w5:FiveWs.subject
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.subject.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.subject.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.subject.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.subject.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.subject.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.subject.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.subject.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.subject.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.subject.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.subject.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| encounter | Σ I | 0..1 | Reference(UK Core Encounter) | Element IdShort description Encounter with which this imaging study is associated Definition The 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).
Reference(UK Core Encounter) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:Event.encounter
- w5:FiveWs.context
- rim:inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.encounter.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.encounter.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.encounter.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.encounter.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.encounter.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.encounter.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.encounter.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.encounter.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.encounter.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.encounter.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| started | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdShort description When the study was started Alternate names StudyDate, StudyTime Definition Date and time the study started.
dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
General2011-01-01T11:01:20+03:00
Mappings- rim:n/a
- workflow:Event.occurrence[x]
- w5:FiveWs.init
- rim:.effectiveTime
- dicom:(0008,0020)+(0008,0030)
|
| basedOn | Σ I | 0..* | Reference(AppointmentResponse | UK Core CarePlan | UK Core Task | UK Core Appointment | UK Core ServiceRequest) | Element IdShort description Request fulfilled Definition A 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).
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(AppointmentResponse | UK Core CarePlan | UK Core Task | UK Core Appointment | UK Core ServiceRequest) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:Event.basedOn
- w5:FiveWs.cause
- rim:.outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]
- dicom:(0032,1064)
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.basedOn.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.basedOn.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.basedOn.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.basedOn.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.basedOn.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.basedOn.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.basedOn.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.basedOn.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.basedOn.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.basedOn.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| referrer | Σ I | 0..1 | Reference(UK Core Practitioner | UK Core PractitionerRole) | Element IdShort description Referring physician Alternate names ReferringPhysiciansName Definition The requesting/referring physician.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(UK Core Practitioner | UK Core PractitionerRole) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5:FiveWs.cause
- rim:.outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role
- dicom:(0008,0090)+(0008,0096)
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.referrer.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.referrer.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.referrer.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.referrer.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.referrer.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.referrer.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.referrer.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.referrer.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.referrer.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.referrer.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| interpreter | Σ I | 0..* | Reference(UK Core Practitioner | UK Core PractitionerRole) | Element IdShort description Who interpreted images Alternate names Name of Physician(s) Reading Study Definition Who read the study and interpreted the images or other content.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(UK Core Practitioner | UK Core PractitionerRole) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5:FiveWs.witness
- rim:.participation[typeCode=PRF].role
- dicom:(0008,1060)
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.interpreter.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.interpreter.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.interpreter.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.interpreter.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.interpreter.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.interpreter.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.interpreter.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.interpreter.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.interpreter.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.interpreter.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| endpoint | Σ I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdShort description Study access endpoint Definition The 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.
Reference(Endpoint) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim:Not supported
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.endpoint.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.endpoint.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.endpoint.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.endpoint.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.endpoint.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.endpoint.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.endpoint.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.endpoint.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.endpoint.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.endpoint.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| numberOfSeries | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdImagingStudy.numberOfSeries Number of Study Related Series Alternate names NumberOfStudyRelatedSeries Definition Number 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.
32 bit number; for values larger than this, use decimal
unsignedInt Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- rim:.outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber
- dicom:(0020,1206)
|
| numberOfInstances | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdImagingStudy.numberOfInstances Number of Study Related Instances Alternate names NumberOfStudyRelatedInstances Definition Number 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.
32 bit number; for values larger than this, use decimal
unsignedInt Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- rim:.outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber
- dicom:(0020,1208)
|
| procedureReference | Σ I | 0..1 | Reference(UK Core Procedure) | Element IdImagingStudy.procedureReference The performed Procedure reference Definition The procedure which this ImagingStudy was part of.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(UK Core Procedure) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:Event.partOf
- rim:.outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]
- dicom:(0008,1032)
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.procedureReference.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.procedureReference.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.procedureReference.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.procedureReference.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.procedureReference.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.procedureReference.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.procedureReference.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.procedureReference.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.procedureReference.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.procedureReference.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| procedureCode | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.procedureCode The performed procedure code Alternate names ProcedureCodeSequence Definition The code for the performed procedure type.
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
CodeableConcept Binding The performed procedure type. http://www.rsna.org/RadLex_Playbook.aspx (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Event.code
- rim:.outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]
- dicom:(0008,1032)
|
| location | Σ I | 0..1 | Reference(UK Core Location) | Element IdShort description Where ImagingStudy occurred Definition The 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).
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(UK Core Location) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:Event.location
- w5:FiveWs.where[x]
- v2:EVN.7
- rim:.participation[typeCode=LOC].role
- dicom:(0008,1040) | (0040,0243)
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.location.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.location.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.location.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.location.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.location.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.location.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.location.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.location.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.location.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.location.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdShort description Why the study was requested Definition Description of clinical condition indicating why the ImagingStudy was requested.
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
CodeableConcept Binding The reason for the study. ProcedureReasonCodes (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Event.reasonCode
- w5:FiveWs.why[x]
- rim:.reasonCode
- dicom:(0040,1002)
|
| reasonReference | Σ I | 0..* | Reference(Media | UK Core Condition | UK Core Observation | UK Core DiagnosticReport | UK Core DocumentReference) | Element IdImagingStudy.reasonReference Why was study performed Definition Indicates another resource whose existence justifies this Study.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(Media | UK Core Condition | UK Core Observation | UK Core DiagnosticReport | UK Core DocumentReference) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:Event.reasonReference
- w5:FiveWs.why[x]
- v2:EVN.4 or by domain
- rim:.outboundRelationship[typeCode=RSON].target
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.reasonReference.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.reasonReference.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.reasonReference.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.reasonReference.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.reasonReference.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.reasonReference.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.reasonReference.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.reasonReference.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.reasonReference.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.reasonReference.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| note | Σ | 0..* | Annotation | There are no (further) constraints on this element Element IdShort description User-defined comments Definition Per 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.
For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
Annotation Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Act
- workflow:Event.note
- rim:unknown
|
| author[x] | Σ | 0..1 | | There are no (further) constraints on this element Element IdImagingStudy.note.author[x] Individual responsible for the annotation Definition The individual responsible for making the annotation.
Organization is used when there's no need for specific attribution as to who made the comment.
- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Act.participant[typeCode=AUT].role
|
| authorString | | | string | Data Type string |
| authorReference | | | Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization) | Data Type Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization) |
| time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdShort description When the annotation was made Definition Indicates when this particular annotation was made.
dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Act.effectiveTime
|
| text | Σ | 1..1 | markdown | There are no (further) constraints on this element Element IdShort description The annotation - text content (as markdown) Definition The text of the annotation in markdown format.
Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
markdown Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Act.text
|
| description | Σ | 0..1 | string | There are no (further) constraints on this element Element IdShort description Institution-generated description Alternate names StudyDescription Definition The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- rim:.text
- dicom:(0008,1030)
|
| series | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort description Each study has one or more series of instances Definition Each study has one or more series of images or other content.
BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- rim:.outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]
|
| uid | Σ | 1..1 | id | There are no (further) constraints on this element Element IdShort description DICOM Series Instance UID for the series Alternate names SeriesInstanceUID Definition The DICOM Series Instance UID for the series.
DICOM Series Instance UID.
id Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
General2.16.124.113543.6003.2588828330.45298.17418.2723805630
Mappings- rim:n/a
- rim:.id
- dicom:(0020,000E)
|
| number | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdImagingStudy.series.number Numeric identifier of this series Alternate names SeriesNumber Definition The numeric identifier of this series in the study.
32 bit number; for values larger than this, use decimal
unsignedInt Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:.inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber
- dicom:(0020,0011)
|
| modality | Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element IdImagingStudy.series.modality The modality of the instances in the series Alternate names Modality Definition The modality of this series sequence.
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.
Coding Binding Type of acquired data in the instance. http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- rim:.code
- dicom:(0008,0060)
|
| description | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.series.description A short human readable summary of the series Alternate names SeriesDescription Definition A description of the series.
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:.text
- dicom:(0008,103E)
|
| numberOfInstances | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdImagingStudy.series.numberOfInstances Number of Series Related Instances Alternate names NumberOfSeriesRelatedInstances Definition Number of SOP Instances in the Study. The 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.
32 bit number; for values larger than this, use decimal
unsignedInt Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- rim:.outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber
- dicom:(0020,1209)
|
| endpoint | Σ I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdImagingStudy.series.endpoint Series access endpoint Definition The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.
Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the series or the series’ instances. A baseLocation specified at the series level has precedence over a baseLocation of the same type specified at the study level.
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; and DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances.
Reference(Endpoint) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim:Not supported
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.series.endpoint.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.series.endpoint.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.series.endpoint.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.series.endpoint.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.series.endpoint.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.series.endpoint.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.series.endpoint.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.series.endpoint.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.series.endpoint.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.series.endpoint.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| bodySite | Σ | 0..1 | Coding | There are no (further) constraints on this element Element IdImagingStudy.series.bodySite Body part examined Alternate names BodyPartExamined 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. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.
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.
Coding Binding Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- rim:.targetSiteCode
- dicom:(0018,0015)
|
| laterality | Σ | 0..1 | Coding | There are no (further) constraints on this element Element IdImagingStudy.series.laterality Body part laterality Definition The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.
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.
Coding Binding Codes describing body site laterality (left, right, etc.). Laterality (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- rim:.targetSiteCode
- dicom:(0020,0060)
|
| specimen | Σ I | 0..* | Reference(UK Core Specimen) | Element IdImagingStudy.series.specimen Specimen imaged Definition The specimen imaged, e.g., for whole slide imaging of a biopsy.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(UK Core Specimen) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim:Role[classCode=SPEC]
- dicom:(0040,0551) + (0040,0562)
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.series.specimen.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.series.specimen.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.series.specimen.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.series.specimen.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.series.specimen.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.series.specimen.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.series.specimen.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.series.specimen.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.series.specimen.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.series.specimen.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| started | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdImagingStudy.series.started When the series started Definition The date and time the series was started.
dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- rim:.effectiveTime
- dicom:(0008,0021) + (0008,0031)
|
| performer | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdImagingStudy.series.performer Who performed the series Alternate names PerformingPhysicianName, OperatorName Definition Indicates who or what performed the series and how they were involved.
The performer is recorded at the series level, since each series in a study may be performed by a different performer, at different times, and using different devices. A series may be performed by multiple performers.
If the person who performed the series is not known, their Organization may be recorded. A patient, or related person, may be the performer, e.g. for patient-captured images.
BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- workflow:Event.performer
- rim:.participation[typeCode=PRF].role
- dicom:(0008, 1050) | (0008, 1052) | (0008, 1070) | (0008, 1072)
|
| function | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.series.performer.function Type of performance Definition Distinguishes the type of involvement of the performer in the series.
Allows disambiguation of the types of involvement of different performers.
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
CodeableConcept Binding The type of involvement of the performer. ImagingStudySeriesPerformerFunction (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:.participation[typeCode=PRF].role
|
| actor | Σ I | 1..1 | Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Organization | UK Core CareTeam | UK Core Patient | UK Core Device | UK Core RelatedPerson) | Element IdImagingStudy.series.performer.actor Who performed the series Definition Indicates who or what performed the series.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Organization | UK Core CareTeam | UK Core Patient | UK Core Device | UK Core RelatedPerson) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5:FiveWs.actor
- v2:EVN.5 or by domain
- rim:.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.series.performer.actor.reference Literal reference, Relative, internal or absolute URL 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.
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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdImagingStudy.series.performer.actor.type Type the reference refers to (e.g. "Patient") 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).
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.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdImagingStudy.series.performer.actor.identifier Logical reference, when literal reference is not known 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.
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).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdImagingStudy.series.performer.actor.identifier.use usual | official | temp | secondary | old (If known) Definition The 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.
code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdImagingStudy.series.performer.actor.identifier.type Description of identifier Definition A 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.
CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdImagingStudy.series.performer.actor.identifier.system The namespace for the identifier value Definition Establishes 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.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.series.performer.actor.identifier.value The value that is unique Definition The 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdImagingStudy.series.performer.actor.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdImagingStudy.series.performer.actor.identifier.assigner Organization that issued id (may be just text) Definition Organization 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.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.series.performer.actor.display Text alternative for the resource Definition Plain 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| instance | | 0..* | BackboneElement | There are no (further) constraints on this element Element IdImagingStudy.series.instance A single SOP instance from the series Definition A single SOP instance within the series, e.g. an image, or presentation state.
BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- rim:.outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]
|
| uid | | 1..1 | id | There are no (further) constraints on this element Element IdImagingStudy.series.instance.uid DICOM SOP Instance UID Alternate names SOPInstanceUID Definition The DICOM SOP Instance UID for this image or other DICOM content.
id Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
General2.16.124.113543.6003.189642796.63084.16748.2599092903
Mappings- rim:n/a
- rim:.id
- dicom:(0008,0018)
|
| sopClass | | 1..1 | CodingBinding | There are no (further) constraints on this element Element IdImagingStudy.series.instance.sopClass DICOM class type Alternate names SOPClassUID Definition 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.
Coding Binding The sopClass for the instance. http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim:CV
- orim:fhir:Coding rdfs:subClassOf dt:CDCoding
- rim:.inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code="sop class"].value
- dicom:(0008,0016)
|
| number | | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdImagingStudy.series.instance.number The number of this instance in the series Alternate names InstanceNumber Definition The number of instance in the series.
32 bit number; for values larger than this, use decimal
unsignedInt Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- rim:.inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber
- dicom:(0020,0013)
|
| title | | 0..1 | string | There are no (further) constraints on this element Element IdImagingStudy.series.instance.title Description of instance Definition The description of the instance.
Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- rim:.title
- dicom:(0008,0008) | (0007,0080) | (0040,A043) + (0008,0104) | (0042,0010)
|
