International Patient Summary Implementation Guide
1.1.0 - CI Build
International Patient Summary Implementation Guide
1.1.0 - CI Build
International Patient Summary Implementation Guide, published by Health Level Seven International - Patient Care Work Group. This is not an authorized publication; it is the continuous build for version 1.1.0). This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips | Version: 1.1.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: ImagingStudyUvIps | ||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImagingStudy
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImagingStudy | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |
  identifier | S | 0..* | Identifier | Identifiers for the whole study |
  subject | S | 1..1 | Reference(Patient (IPS)) | Who or what is the subject of the study |
  reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| started | S | 0..1 | dateTime | When the study was started |
 procedureCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) |
| reasonCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text |
 series | S | 0..* | BackboneElement | Each study has one or more series of instances |
 uid | S | 1..1 | id | DICOM Series Instance UID for the series |
| modality | S | 1..1 | Coding | The modality of the instances in the series |
| instance | S | 0..* | BackboneElement | A single SOP instance from the series |
| uid | S | 1..1 | id | DICOM SOP Instance UID |
| sopClass | S | 1..1 | Coding | DICOM class type |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImagingStudy.procedureCode | extensible | ResultsRadiologyObservationUvIps |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingStudy | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | Identifiers for the whole study |
| status | ?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. |
| subject | SΣ | 1..1 | Reference(Patient (IPS)) | Who or what is the subject of the study |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| started | SΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00 |
| procedureCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) |
| reasonCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ProcedureReasonCodes (example): The reason for the study. |
| series | SΣ | 0..* | BackboneElement | Each study has one or more series of instances |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| uid | SΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
| modality | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance. |
| instance | S | 0..* | BackboneElement | A single SOP instance from the series |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| uid | S | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 |
| sopClass | S | 1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImagingStudy.status | required | ImagingStudyStatus |
| ImagingStudy.procedureCode | extensible | ResultsRadiologyObservationUvIps |
| ImagingStudy.reasonCode | example | ProcedureReasonCodes |
| ImagingStudy.series.modality | extensible | AcquisitionModality |
| ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImagingStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImagingStudy | 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-4 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImagingStudy | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ImagingStudy | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifiers for the whole study | ||||
| status | ?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. | ||||
| modality | Σ | 0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible): Type of acquired data in the instance. | ||||
| subject | SΣ | 1..1 | Reference(Patient (IPS)) | Who or what is the subject of the study | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated | ||||
| started | SΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00 | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled | ||||
| referrer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | ||||
| interpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images | ||||
| endpoint | Σ | 0..* | Reference(Endpoint) | Study access endpoint | ||||
| numberOfSeries | Σ | 0..1 | unsignedInt | Number of Study Related Series | ||||
| numberOfInstances | Σ | 0..1 | unsignedInt | Number of Study Related Instances | ||||
| procedureReference | Σ | 0..1 | Reference(Procedure) | The performed Procedure reference | ||||
| procedureCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) | ||||
| location | Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred | ||||
| reasonCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ProcedureReasonCodes (example): The reason for the study. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) | Why was study performed | ||||
| note | Σ | 0..* | Annotation | User-defined comments | ||||
| description | Σ | 0..1 | string | Institution-generated description | ||||
| series | SΣ | 0..* | BackboneElement | Each study has one or more series of instances | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| uid | SΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 | ||||
| number | Σ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3 | ||||
| modality | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance. | ||||
| description | Σ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180 | ||||
| numberOfInstances | Σ | 0..1 | unsignedInt | Number of Series Related Instances | ||||
| endpoint | Σ | 0..* | Reference(Endpoint) | Series access endpoint | ||||
| bodySite | Σ | 0..1 | Coding | Body part examined Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| laterality | Σ | 0..1 | Coding | Body part laterality Binding: Laterality (example): Codes describing body site laterality (left, right, etc.). | ||||
| specimen | Σ | 0..* | Reference(Specimen) | Specimen imaged | ||||
| started | Σ | 0..1 | dateTime | When the series started | ||||
| performer | Σ | 0..* | BackboneElement | Who performed the series | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. | ||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Who performed the series | ||||
| instance | S | 0..* | BackboneElement | A single SOP instance from the series | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| uid | S | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | ||||
| sopClass | S | 1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. | ||||
| number | 0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||
| title | 0..1 | string | Description of instance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| ImagingStudy.language | preferred | CommonLanguages
| ||||
| ImagingStudy.status | required | ImagingStudyStatus | ||||
| ImagingStudy.modality | extensible | AcquisitionModality | ||||
| ImagingStudy.subject.type | extensible | ResourceType | ||||
| ImagingStudy.procedureCode | extensible | ResultsRadiologyObservationUvIps | ||||
| ImagingStudy.reasonCode | example | ProcedureReasonCodes | ||||
| ImagingStudy.series.modality | extensible | AcquisitionModality | ||||
| ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructures | ||||
| ImagingStudy.series.laterality | example | Laterality | ||||
| ImagingStudy.series.performer.function | extensible | ImagingStudySeriesPerformerFunction | ||||
| ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ImagingStudy
Summary
Mandatory: 1 element
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Maturity: 2
Differential View
This structure is derived from ImagingStudy
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingStudy | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |
| identifier | S | 0..* | Identifier | Identifiers for the whole study |
| subject | S | 1..1 | Reference(Patient (IPS)) | Who or what is the subject of the study |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| started | S | 0..1 | dateTime | When the study was started |
| procedureCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) |
| reasonCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text |
| series | S | 0..* | BackboneElement | Each study has one or more series of instances |
| uid | S | 1..1 | id | DICOM Series Instance UID for the series |
| modality | S | 1..1 | Coding | The modality of the instances in the series |
| instance | S | 0..* | BackboneElement | A single SOP instance from the series |
| uid | S | 1..1 | id | DICOM SOP Instance UID |
| sopClass | S | 1..1 | Coding | DICOM class type |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImagingStudy.procedureCode | extensible | ResultsRadiologyObservationUvIps |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingStudy | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | Identifiers for the whole study |
| status | ?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. |
| subject | SΣ | 1..1 | Reference(Patient (IPS)) | Who or what is the subject of the study |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| started | SΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00 |
| procedureCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) |
| reasonCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ProcedureReasonCodes (example): The reason for the study. |
| series | SΣ | 0..* | BackboneElement | Each study has one or more series of instances |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| uid | SΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
| modality | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance. |
| instance | S | 0..* | BackboneElement | A single SOP instance from the series |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| uid | S | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 |
| sopClass | S | 1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImagingStudy.status | required | ImagingStudyStatus |
| ImagingStudy.procedureCode | extensible | ResultsRadiologyObservationUvIps |
| ImagingStudy.reasonCode | example | ProcedureReasonCodes |
| ImagingStudy.series.modality | extensible | AcquisitionModality |
| ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImagingStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImagingStudy | 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-4 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImagingStudy | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ImagingStudy | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifiers for the whole study | ||||
| status | ?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. | ||||
| modality | Σ | 0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible): Type of acquired data in the instance. | ||||
| subject | SΣ | 1..1 | Reference(Patient (IPS)) | Who or what is the subject of the study | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated | ||||
| started | SΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00 | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled | ||||
| referrer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | ||||
| interpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images | ||||
| endpoint | Σ | 0..* | Reference(Endpoint) | Study access endpoint | ||||
| numberOfSeries | Σ | 0..1 | unsignedInt | Number of Study Related Series | ||||
| numberOfInstances | Σ | 0..1 | unsignedInt | Number of Study Related Instances | ||||
| procedureReference | Σ | 0..1 | Reference(Procedure) | The performed Procedure reference | ||||
| procedureCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Radiology Observation - IPS (extensible) | ||||
| location | Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred | ||||
| reasonCode | S | 0..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: ProcedureReasonCodes (example): The reason for the study. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) | Why was study performed | ||||
| note | Σ | 0..* | Annotation | User-defined comments | ||||
| description | Σ | 0..1 | string | Institution-generated description | ||||
| series | SΣ | 0..* | BackboneElement | Each study has one or more series of instances | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| uid | SΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 | ||||
| number | Σ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3 | ||||
| modality | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance. | ||||
| description | Σ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180 | ||||
| numberOfInstances | Σ | 0..1 | unsignedInt | Number of Series Related Instances | ||||
| endpoint | Σ | 0..* | Reference(Endpoint) | Series access endpoint | ||||
| bodySite | Σ | 0..1 | Coding | Body part examined Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| laterality | Σ | 0..1 | Coding | Body part laterality Binding: Laterality (example): Codes describing body site laterality (left, right, etc.). | ||||
| specimen | Σ | 0..* | Reference(Specimen) | Specimen imaged | ||||
| started | Σ | 0..1 | dateTime | When the series started | ||||
| performer | Σ | 0..* | BackboneElement | Who performed the series | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. | ||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Who performed the series | ||||
| instance | S | 0..* | BackboneElement | A single SOP instance from the series | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| uid | S | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | ||||
| sopClass | S | 1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. | ||||
| number | 0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||
| title | 0..1 | string | Description of instance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| ImagingStudy.language | preferred | CommonLanguages
| ||||
| ImagingStudy.status | required | ImagingStudyStatus | ||||
| ImagingStudy.modality | extensible | AcquisitionModality | ||||
| ImagingStudy.subject.type | extensible | ResourceType | ||||
| ImagingStudy.procedureCode | extensible | ResultsRadiologyObservationUvIps | ||||
| ImagingStudy.reasonCode | example | ProcedureReasonCodes | ||||
| ImagingStudy.series.modality | extensible | AcquisitionModality | ||||
| ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructures | ||||
| ImagingStudy.series.laterality | example | Laterality | ||||
| ImagingStudy.series.performer.function | extensible | ImagingStudySeriesPerformerFunction | ||||
| ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ImagingStudy
Summary
Mandatory: 1 element
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ Health Level Seven International - Patient Care Work Group. Package hl7.fhir.uv.ips#1.1.0 based on FHIR 4.0.1. Generated 2022-12-07
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change