Publish Box goes here
JSON Format: StructureDefinition-ImagingStudy-uv-ips
Raw json
{
"resourceType" : "StructureDefinition",
"id" : "ImagingStudy-uv-ips",
"meta" : {
"lastUpdated" : "2018-02-25T13:25:33.511+01:00"
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">This profile represents the constraints applied to the ImagingStudy resource by the IPS project, which specifies the information on a DICOM imaging study this imaging result is part of.\r\n</div>"
},
"url" : "http://hl7.eu/fhir/trillium2/StructureDefinition/ImagingStudy-uv-ips",
"version" : "0.1.0",
"name" : "ImagingStudy_uv_ips",
"title" : "Imaging Study (Trillium II)",
"status" : "draft",
"date" : "2018-02-20T13:22:59+01:00",
"description" : "This profile represents the constraints applied to the ImagingStudy resource by the IPS project, which specifies the information on a DICOM imaging study this imaging result is part of.\r\n",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"fhirVersion" : "3.0.1",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "dicom",
"uri" : "http://nema.org/dicom",
"name" : "DICOM Tag Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/w5",
"name" : "W5 Mapping"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "ImagingStudy",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "ImagingStudy",
"path" : "ImagingStudy",
"short" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-1",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression" : "contained.text.empty()",
"xpath" : "not(parent::f:contained and f:text)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression" : "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath" : "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source" : "DomainResource"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Act[classCode=COMPOSITION, moodCode=EVN]"
},
{
"identity" : "dicom",
"map" : "Reference IHE radiology TF vol 2 table 4.14-1"
},
{
"identity" : "w5",
"map" : "clinical.diagnostics"
}
]
},
{
"id" : "ImagingStudy.id",
"path" : "ImagingStudy.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "id"
}
],
"isSummary" : true
},
{
"id" : "ImagingStudy.meta",
"path" : "ImagingStudy.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Meta"
}
],
"isSummary" : true
},
{
"id" : "ImagingStudy.implicitRules",
"path" : "ImagingStudy.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"isModifier" : true,
"isSummary" : true
},
{
"id" : "ImagingStudy.language",
"path" : "ImagingStudy.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A human language.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id" : "ImagingStudy.text",
"path" : "ImagingStudy.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"condition" : [
"dom-1"
],
"mapping" : [
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "ImagingStudy.contained",
"path" : "ImagingStudy.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "ImagingStudy.extension",
"path" : "ImagingStudy.extension",
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "ImagingStudy.modifierExtension",
"path" : "ImagingStudy.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "ImagingStudy.uid",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "dicom="
}
],
"path" : "ImagingStudy.uid",
"short" : "Formal DICOM identifier for the study",
"definition" : "Formal identifier for the study.",
"alias" : [
"StudyInstanceUID"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ImagingStudy.uid",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "oid"
}
],
"example" : [
{
"label" : "General",
"valueOid" : "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "dicom",
"map" : "(0020,000D)"
},
{
"identity" : "w5",
"map" : "id"
}
]
},
{
"id" : "ImagingStudy.accession",
"path" : "ImagingStudy.accession",
"short" : "Related workflow identifier (\"Accession Number\")",
"definition" : "Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).",
"alias" : [
"AccessionNumber"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.accession",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id"
},
{
"identity" : "dicom",
"map" : "(0008,0050)"
},
{
"identity" : "w5",
"map" : "id"
}
]
},
{
"id" : "ImagingStudy.identifier",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "dicom="
}
],
"path" : "ImagingStudy.identifier",
"short" : "Other identifiers for the study",
"definition" : "Other identifiers for the study.",
"alias" : [
"StudyID"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".id (no means to distinguish from uid)"
},
{
"identity" : "dicom",
"map" : "(0020,0010)"
},
{
"identity" : "w5",
"map" : "id"
}
]
},
{
"id" : "ImagingStudy.availability",
"path" : "ImagingStudy.availability",
"short" : "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE",
"definition" : "Availability of study (online, offline, or nearline).",
"alias" : [
"InstanceAvailability"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.availability",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InstanceAvailability"
}
],
"strength" : "required",
"description" : "Availability of the resource",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/instance-availability"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "Not supported"
},
{
"identity" : "w5",
"map" : "status"
}
]
},
{
"id" : "ImagingStudy.modalityList",
"path" : "ImagingStudy.modalityList",
"short" : "All series modality if actual acquisition modalities",
"definition" : "A list of all the Series.ImageModality 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).",
"alias" : [
"ModalitiesInStudy"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy.modalityList",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ImagingModality"
}
],
"strength" : "extensible",
"description" : "Type of acquired data in the instance",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/dicom-cid29"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "dicom",
"map" : "(0008,0061)"
},
{
"identity" : "w5",
"map" : "class"
}
]
},
{
"id" : "ImagingStudy.patient",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "dicom=http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.2.2.html"
}
],
"path" : "ImagingStudy.patient",
"short" : "Who the images are of",
"definition" : "The patient imaged in the study.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ImagingStudy.patient",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.eu/fhir/trillium2/StructureDefinition/Patient-uv-ips"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "dicom",
"map" : "(0010/*)"
},
{
"identity" : "w5",
"map" : "who.focus"
}
]
},
{
"id" : "ImagingStudy.patient.id",
"path" : "ImagingStudy.patient.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ImagingStudy.patient.extension",
"path" : "ImagingStudy.patient.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ImagingStudy.patient.reference",
"path" : "ImagingStudy.patient.reference",
"short" : "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.",
"comment" : "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.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ref-1"
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "ImagingStudy.patient.identifier",
"path" : "ImagingStudy.patient.identifier",
"short" : "Logical reference, when literal reference is not known",
"definition" : "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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.",
"comment" : "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. \n\nWhen 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\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "ImagingStudy.patient.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "ImagingStudy.patient.display",
"short" : "Text alternative for the resource",
"definition" : "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "ImagingStudy.context",
"path" : "ImagingStudy.context",
"short" : "Originating context",
"definition" : "The encounter or episode at which the request is initiated.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.context",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
},
{
"identity" : "w5",
"map" : "context"
}
]
},
{
"id" : "ImagingStudy.started",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "dicom=http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.2.html#sect_C.7.2.1"
}
],
"path" : "ImagingStudy.started",
"short" : "When the study was started",
"definition" : "Date and time the study started.",
"alias" : [
"StudyDate",
"StudyTime"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.started",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"example" : [
{
"label" : "General",
"valueDateTime" : "2011-01-01T11:01:20+03:00"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".effectiveTime"
},
{
"identity" : "dicom",
"map" : "(0008,0020)+(0008,0030)"
},
{
"identity" : "w5",
"map" : "when.init"
}
]
},
{
"id" : "ImagingStudy.basedOn",
"path" : "ImagingStudy.basedOn",
"short" : "Request fulfilled",
"definition" : "A list of the diagnostic requests that resulted in this imaging study being performed.",
"requirements" : "To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/CarePlan"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]"
},
{
"identity" : "w5",
"map" : "who.cause"
}
]
},
{
"id" : "ImagingStudy.referrer",
"path" : "ImagingStudy.referrer",
"short" : "Referring physician",
"definition" : "The requesting/referring physician.",
"alias" : [
"ReferringPhysiciansName"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.referrer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role"
},
{
"identity" : "w5",
"map" : "who.cause"
}
]
},
{
"id" : "ImagingStudy.interpreter",
"path" : "ImagingStudy.interpreter",
"short" : "Who interpreted images",
"definition" : "Who read the study and interpreted the images or other content.",
"alias" : [
"Name of Physician(s) Reading Study"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy.interpreter",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.eu/fhir/trillium2/StructureDefinition/practitioner-uv-ips"
}
],
"mustSupport" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role"
},
{
"identity" : "dicom",
"map" : "(0008,1060)"
},
{
"identity" : "w5",
"map" : "who.witness"
}
]
},
{
"id" : "ImagingStudy.endpoint",
"path" : "ImagingStudy.endpoint",
"short" : "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.type.",
"comment" : "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.",
"requirements" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy.endpoint",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Endpoint"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "Not supported"
}
]
},
{
"id" : "ImagingStudy.numberOfSeries",
"path" : "ImagingStudy.numberOfSeries",
"short" : "Number of Study Related Series",
"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.",
"alias" : [
"NumberOfStudyRelatedSeries"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.numberOfSeries",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "unsignedInt"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber"
},
{
"identity" : "dicom",
"map" : "(0020,1206)"
}
]
},
{
"id" : "ImagingStudy.numberOfInstances",
"path" : "ImagingStudy.numberOfInstances",
"short" : "Number of Study Related Instances",
"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.",
"alias" : [
"NumberOfStudyRelatedInstances"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.numberOfInstances",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "unsignedInt"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
},
{
"identity" : "dicom",
"map" : "(0020,1208)"
}
]
},
{
"id" : "ImagingStudy.procedureReference",
"path" : "ImagingStudy.procedureReference",
"short" : "The performed Procedure reference",
"definition" : "A reference to the performed Procedure.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy.procedureReference",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Procedure"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
},
{
"identity" : "dicom",
"map" : "(0008,1032)"
}
]
},
{
"id" : "ImagingStudy.procedureCode",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "ImagingStudy.procedureCode",
"short" : "Concept - reference to a terminology or just text",
"definition" : "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"comment" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy.procedureCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept",
"profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mustSupport" : true,
"isModifier" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ImagingProcedureCode"
}
],
"strength" : "example",
"description" : "The performed procedure type",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/procedure-code"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
}
]
},
{
"id" : "ImagingStudy.reason",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}
],
"path" : "ImagingStudy.reason",
"short" : "Concept - reference to a terminology or just text",
"definition" : "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"comment" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.reason",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept",
"profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mustSupport" : true,
"isModifier" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ImagingReason"
}
],
"strength" : "example",
"description" : "The reason for the study",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/procedure-reason"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
}
]
},
{
"id" : "ImagingStudy.reason.id",
"path" : "ImagingStudy.reason.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ImagingStudy.reason.extension",
"path" : "ImagingStudy.reason.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ImagingStudy.reason.coding",
"path" : "ImagingStudy.reason.coding",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"comment" : "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CodeableConcept.coding",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding",
"profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.1-8, C*E.10-22"
},
{
"identity" : "rim",
"map" : "union(., ./translation)"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
}
]
},
{
"id" : "ImagingStudy.reason.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "ImagingStudy.reason.text",
"short" : "Plain text representation of the concept",
"definition" : "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"comment" : "Very often the text is the same as a displayName of one of the codings.",
"requirements" : "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CodeableConcept.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity" : "rim",
"map" : "./originalText[mediaType/code=\"text/plain\"]/data"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
}
]
},
{
"id" : "ImagingStudy.description",
"path" : "ImagingStudy.description",
"short" : "Institution-generated description",
"definition" : "Institution-generated description or classification of the Study performed.",
"alias" : [
"StudyDescription"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.description",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".text"
},
{
"identity" : "dicom",
"map" : "(0008,1030)"
}
]
},
{
"id" : "ImagingStudy.series",
"path" : "ImagingStudy.series",
"short" : "Each study has one or more series of instances",
"definition" : "Each study has one or more series of images or other content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy.series",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]"
}
]
},
{
"id" : "ImagingStudy.series.id",
"path" : "ImagingStudy.series.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ImagingStudy.series.extension",
"path" : "ImagingStudy.series.extension",
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ImagingStudy.series.modifierExtension",
"path" : "ImagingStudy.series.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "ImagingStudy.series.uid",
"path" : "ImagingStudy.series.uid",
"short" : "Formal DICOM identifier for this series",
"definition" : "Formal identifier for this series.",
"alias" : [
"SeriesInstanceUID"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.uid",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "oid"
}
],
"example" : [
{
"label" : "General",
"valueOid" : "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "dicom",
"map" : "(0020,000E)"
}
]
},
{
"id" : "ImagingStudy.series.number",
"path" : "ImagingStudy.series.number",
"short" : "Numeric identifier of this series",
"definition" : "The numeric identifier of this series in the study.",
"alias" : [
"SeriesNumber"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.number",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "unsignedInt"
}
],
"example" : [
{
"label" : "General",
"valueInteger" : 3
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber"
},
{
"identity" : "dicom",
"map" : "(0020,0011)"
}
]
},
{
"id" : "ImagingStudy.series.modality",
"path" : "ImagingStudy.series.modality",
"short" : "The modality of the instances in the series",
"definition" : "The modality of this series sequence.",
"alias" : [
"Modality"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.modality",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"mustSupport" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ImagingModality"
}
],
"strength" : "extensible",
"description" : "Type of acquired data in the instance",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/dicom-cid29"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "dicom",
"map" : "(0008,0060)"
}
]
},
{
"id" : "ImagingStudy.series.description",
"path" : "ImagingStudy.series.description",
"short" : "A short human readable summary of the series",
"definition" : "A description of the series.",
"alias" : [
"SeriesDescription"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.description",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "CT Surview 180"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".text"
},
{
"identity" : "dicom",
"map" : "(0008,103E)"
}
]
},
{
"id" : "ImagingStudy.series.numberOfInstances",
"path" : "ImagingStudy.series.numberOfInstances",
"short" : "Number of Series Related Instances",
"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.",
"alias" : [
"NumberOfSeriesRelatedInstances"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.numberOfInstances",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "unsignedInt"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
},
{
"identity" : "dicom",
"map" : "(0020,1209)"
}
]
},
{
"id" : "ImagingStudy.series.availability",
"path" : "ImagingStudy.series.availability",
"short" : "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE",
"definition" : "Availability of series (online, offline or nearline).",
"alias" : [
"InstanceAvailability"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.availability",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "InstanceAvailability"
}
],
"strength" : "required",
"description" : "Availability of the resource",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/instance-availability"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"availability\"].value"
},
{
"identity" : "dicom",
"map" : "(0008,0056)"
}
]
},
{
"id" : "ImagingStudy.series.endpoint",
"path" : "ImagingStudy.series.endpoint",
"short" : "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.type.",
"comment" : "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.",
"requirements" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy.series.endpoint",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Endpoint"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "Not supported"
}
]
},
{
"id" : "ImagingStudy.series.bodySite",
"path" : "ImagingStudy.series.bodySite",
"short" : "Body part examined",
"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.",
"alias" : [
"BodyPartExamined"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.bodySite",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}
],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/body-site"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".targetSiteCode"
},
{
"identity" : "dicom",
"map" : "(0018,0015)"
}
]
},
{
"id" : "ImagingStudy.series.laterality",
"path" : "ImagingStudy.series.laterality",
"short" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.laterality",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Laterality"
}
],
"strength" : "example",
"description" : "Codes describing body site laterality (left, right, etc.).",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/bodysite-laterality"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".targetSiteCode"
},
{
"identity" : "dicom",
"map" : "(0020,0060)"
}
]
},
{
"id" : "ImagingStudy.series.started",
"path" : "ImagingStudy.series.started",
"short" : "When the series started",
"definition" : "The date and time the series was started.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.started",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".effectiveTime"
},
{
"identity" : "dicom",
"map" : "(0008,0021) + (0008,0031)"
}
]
},
{
"id" : "ImagingStudy.series.performer",
"path" : "ImagingStudy.series.performer",
"short" : "Who performed the series",
"definition" : "The physician or operator (often the radiology technician) who performed the series. The performer is recorded at the series level, since each series in a study may be performed by a different practitioner, at different times, and using different devices. A series may be performed by multiple practitioners.",
"alias" : [
"PerformingPhysicianName",
"OperatorName"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy.series.performer",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role"
},
{
"identity" : "dicom",
"map" : "(0008,1050) | (0008,1072)"
},
{
"identity" : "w5",
"map" : "who.actor"
}
]
},
{
"id" : "ImagingStudy.series.instance",
"path" : "ImagingStudy.series.instance",
"short" : "A single SOP instance from the series",
"definition" : "A single SOP instance within the series, e.g. an image, or presentation state.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ImagingStudy.series.instance",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]"
}
]
},
{
"id" : "ImagingStudy.series.instance.id",
"path" : "ImagingStudy.series.instance.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ImagingStudy.series.instance.extension",
"path" : "ImagingStudy.series.instance.extension",
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "ImagingStudy.series.instance.modifierExtension",
"path" : "ImagingStudy.series.instance.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "ImagingStudy.series.instance.uid",
"path" : "ImagingStudy.series.instance.uid",
"short" : "Formal DICOM identifier for this instance",
"definition" : "Formal identifier for this image or other content.",
"alias" : [
"SOPInstanceUID"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.instance.uid",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "oid"
}
],
"example" : [
{
"label" : "General",
"valueOid" : "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "dicom",
"map" : "(0008,0018)"
}
]
},
{
"id" : "ImagingStudy.series.instance.number",
"path" : "ImagingStudy.series.instance.number",
"short" : "The number of this instance in the series",
"definition" : "The number of instance in the series.",
"alias" : [
"InstanceNumber"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.instance.number",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "unsignedInt"
}
],
"example" : [
{
"label" : "General",
"valueInteger" : 1
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber"
},
{
"identity" : "dicom",
"map" : "(0020,0013)"
}
]
},
{
"id" : "ImagingStudy.series.instance.sopClass",
"path" : "ImagingStudy.series.instance.sopClass",
"short" : "DICOM class type",
"definition" : "DICOM instance type.",
"alias" : [
"SOPClassUID"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.instance.sopClass",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "oid"
}
],
"example" : [
{
"label" : "General",
"valueOid" : "urn:oid:1.2.840.10008.5.1.4.1.1.2"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value"
},
{
"identity" : "dicom",
"map" : "(0008,0016)"
}
]
},
{
"id" : "ImagingStudy.series.instance.title",
"path" : "ImagingStudy.series.instance.title",
"short" : "Description of instance",
"definition" : "The description of the instance.",
"comment" : "Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ImagingStudy.series.instance.title",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".title"
},
{
"identity" : "dicom",
"map" : "(0070,0080) | (0040,A043) > (0008,0104) | (0042,0010) | (0008,0008)"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "ImagingStudy",
"path" : "ImagingStudy",
"mustSupport" : true
},
{
"id" : "ImagingStudy.identifier",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "dicom="
}
],
"path" : "ImagingStudy.identifier",
"mustSupport" : true
},
{
"id" : "ImagingStudy.patient",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "dicom=http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.2.2.html"
}
],
"path" : "ImagingStudy.patient",
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.eu/fhir/trillium2/StructureDefinition/Patient-uv-ips"
}
],
"mustSupport" : true
},
{
"id" : "ImagingStudy.patient.reference",
"path" : "ImagingStudy.patient.reference",
"min" : 1,
"mustSupport" : true
},
{
"id" : "ImagingStudy.started",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "dicom=http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.2.html#sect_C.7.2.1"
}
],
"path" : "ImagingStudy.started",
"mustSupport" : true
},
{
"id" : "ImagingStudy.interpreter",
"path" : "ImagingStudy.interpreter",
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.eu/fhir/trillium2/StructureDefinition/practitioner-uv-ips"
}
],
"mustSupport" : false
},
{
"id" : "ImagingStudy.procedureCode",
"path" : "ImagingStudy.procedureCode",
"type" : [
{
"code" : "CodeableConcept",
"profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
}
],
"mustSupport" : true
},
{
"id" : "ImagingStudy.reason",
"path" : "ImagingStudy.reason",
"type" : [
{
"code" : "CodeableConcept",
"profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips"
}
],
"mustSupport" : true
},
{
"id" : "ImagingStudy.reason.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "ImagingStudy.reason.text",
"mustSupport" : true
},
{
"id" : "ImagingStudy.series",
"path" : "ImagingStudy.series",
"mustSupport" : true
},
{
"id" : "ImagingStudy.series.uid",
"path" : "ImagingStudy.series.uid",
"mustSupport" : true
},
{
"id" : "ImagingStudy.series.modality",
"path" : "ImagingStudy.series.modality",
"mustSupport" : true
},
{
"id" : "ImagingStudy.series.instance",
"path" : "ImagingStudy.series.instance",
"mustSupport" : true
},
{
"id" : "ImagingStudy.series.instance.uid",
"path" : "ImagingStudy.series.instance.uid",
"mustSupport" : true
},
{
"id" : "ImagingStudy.series.instance.sopClass",
"path" : "ImagingStudy.series.instance.sopClass",
"mustSupport" : true
}
]
}
}
