Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions . Page versions: R5 R4B R4 R3

Imagingstudy.shex

Maturity Level : N/A
Responsible Owner: Imaging Integration Work Group Standards Status : Informative Compartments : Group , Patient

Raw ShEx

ShEx statement for imagingstudy 

PREFIX fhir: <http://hl7.org/fhir/> 
PREFIX fhirvs: <http://hl7.org/fhir/ValueSet/>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#> 
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> 
IMPORT <id.shex>
IMPORT <code.shex>

# ShEx Version 2.2
IMPORT <Id.shex>
IMPORT <Oid.shex>
IMPORT <Code.shex>

IMPORT <Task.shex>
IMPORT <Group.shex>
IMPORT <Device.shex>
IMPORT <string.shex>
IMPORT <Coding.shex>

IMPORT <String.shex>

IMPORT <Patient.shex>
IMPORT <dateTime.shex>

IMPORT <DateTime.shex>

IMPORT <Location.shex>
IMPORT <CareTeam.shex>
IMPORT <CarePlan.shex>
IMPORT <Endpoint.shex>
IMPORT <Specimen.shex>
IMPORT <Reference.shex>
IMPORT <Encounter.shex>
IMPORT <Procedure.shex>
IMPORT <Identifier.shex>
IMPORT <Annotation.shex>
IMPORT <unsignedInt.shex>

IMPORT <UnsignedInt.shex>

IMPORT <Appointment.shex>
IMPORT <Practitioner.shex>
IMPORT <Organization.shex>
IMPORT <RelatedPerson.shex>
IMPORT <DomainResource.shex>
IMPORT <ServiceRequest.shex>
IMPORT <CodeableConcept.shex>
IMPORT <BackboneElement.shex>
IMPORT <PractitionerRole.shex>
IMPORT <CodeableReference.shex>
IMPORT <HealthcareService.shex>
IMPORT <AppointmentResponse.shex>

start=@<ImagingStudy> AND {fhir:nodeRole [fhir:treeRoot]}
# A set of images produced in single study (one or more series of references images)

# A set of images or image-related data produced in single study

<ImagingStudy> EXTENDS @<DomainResource> CLOSED {   
    a [fhir:ImagingStudy]?;fhir:nodeRole [fhir:treeRoot]?;

    a [fhir:ImagingStudy]?;
    fhir:nodeRole [fhir:treeRoot]?;
    fhir:identifier @<OneOrMore_Identifier>?;  # Identifiers for the whole study
    fhir:status @<code> AND

    fhir:identifier @<OneOrMore_Identifier>?;  # Business identifier for imaging 
                                            # study 
    fhir:status @<Code> AND

    	{fhir:v @fhirvs:imagingstudy-status};  # registered | available | cancelled 
                                            # | entered-in-error | unknown 
    fhir:modality @<OneOrMore_CodeableConcept>?;  # All of the distinct values for 
                                            # series' modalities 
    fhir:subject @<Reference> AND {fhir:link 

                                            # | entered-in-error | unknown | 
                                            # inactive 
    fhir:modality @<OneOrMore_CodeableConcept>?;  # The distinct values for series' 
                                            # modalities 
    fhir:subject @<Reference> AND {fhir:l 

    			@<Device> OR 
    			@<Group> OR 
    			@<Patient> ? };  # Who or what is the subject of the 
                                            # study 
    fhir:encounter @<Reference> AND {fhir:link 

    fhir:encounter @<Reference> AND {fhir:l 

    			@<Encounter> ? }?;  # Encounter with which this imaging 
                                            # study is associated 
    fhir:started @<dateTime>?;              # When the study was started
    fhir:basedOn @<OneOrMore_Reference_Appointment_OR_AppointmentResponse_OR_CarePlan_OR_ServiceRequest_OR_Task>?;  # Request fulfilled
    fhir:partOf @<OneOrMore_Reference_Procedure>?;  # Part of referenced event
    fhir:referrer @<Reference> AND {fhir:link 

    fhir:started @<DateTime>?;              # When the study was started
    fhir:basedOn @<OneOrMore_Reference_Appointment_OR_CarePlan_OR_ServiceRequest_OR_Task>?;  # Fulfills plan or order
    fhir:procedure @<OneOrMore_Reference_Procedure>?;  # Imaging performed procedure(s)
    fhir:referrer @<Reference> AND {fhir:l 

    			@<Practitioner> OR 
    			@<PractitionerRole> ? }?;  # Referring physician
    fhir:endpoint @<OneOrMore_Reference_Endpoint>?;  # Study access endpoint
    fhir:numberOfSeries @<unsignedInt>?;    # Number of Study Related Series
    fhir:numberOfInstances @<unsignedInt>?;  # Number of Study Related Instances
    fhir:procedure @<OneOrMore_CodeableReference>?;  # The performed procedure or code
    fhir:location @<Reference> AND {fhir:link 
    			@<Location> ? }?;  # Where ImagingStudy occurred
    fhir:reason @<OneOrMore_CodeableReference>?;  # Why the study was requested / 
                                            # performed 
    fhir:note @<OneOrMore_Annotation>?;     # User-defined comments
    fhir:description @<string>?;            # Institution-generated description
    fhir:series @<OneOrMore_ImagingStudy.series>?;  # Each study has one or more series 
                                            # of instances 

    fhir:location @<Reference> AND {fhir:l 
    			@<Location> ? }?;  # Where imaging study occurred
    fhir:reason @<OneOrMore_CodeableReference>?;  #  Why was imaging study performed?
    fhir:note @<OneOrMore_Annotation>?;     # Comments made about the imaging 
                                            # study 
    fhir:description @<String>?;            # Study Description or Classification
    fhir:numberOfSeries @<UnsignedInt>?;    # Number of Study Related Series
    fhir:numberOfInstances @<UnsignedInt>?;  # Number of Study Related Instances
    fhir:series @<OneOrMore_ImagingStudy.series>?;  # The set of Series belonging to the 
                                            # study 
}  
# A single SOP instance from the series
<ImagingStudy.series.instance> EXTENDS @<BackboneElement> CLOSED {   
    fhir:uid @<Id>;                         # DICOM SOP Instance UID
    fhir:sopClass @<Oid>;                   # DICOM class type
    fhir:number @<UnsignedInt>?;            # The number of this instance in the 
                                            # series 
    fhir:title @<String>?;                  # Name or title of the instance

}  
# Who performed the series
<ImagingStudy.series.performer> EXTENDS @<BackboneElement> CLOSED {   
    fhir:function @<CodeableConcept>?;      # Type of performance
    fhir:actor @<Reference> AND {fhir:link 

    fhir:actor @<Reference> AND {fhir:l 

    			@<CareTeam> OR 
    			@<Device> OR 
    			@<HealthcareService> OR 
    			@<Organization> OR 
    			@<Patient> OR 
    			@<Practitioner> OR 
    			@<PractitionerRole> OR 
    			@<RelatedPerson> ? };  # Who performed the series

    			@<RelatedPerson> ? };  # Who performed imaging study

}  
# Each study has one or more series of instances

# The set of Series belonging to the study

<ImagingStudy.series> EXTENDS @<BackboneElement> CLOSED {   
    fhir:uid @<id>;                         # DICOM Series Instance UID for the 
                                            # series 
    fhir:number @<unsignedInt>?;            # Numeric identifier of this series

    fhir:uid @<Id>;                         # DICOM Series Instance UID
    fhir:number @<UnsignedInt>?;            # Numeric identifier of this series

    fhir:modality @<CodeableConcept>;       # The modality used for this series
    fhir:description @<string>?;            # A short human readable summary of 
                                            # the series 
    fhir:numberOfInstances @<unsignedInt>?;  # Number of Series Related Instances

    fhir:description @<String>?;            # Series Description or 
                                            # Classification 
    fhir:numberOfInstances @<UnsignedInt>?;  # Number of Series Related Instances

    fhir:endpoint @<OneOrMore_Reference_Endpoint>?;  # Series access endpoint
    fhir:bodySite @<CodeableReference>?;    # Body part examined
    fhir:laterality @<CodeableConcept>?;    # Body part laterality

    fhir:specimen @<OneOrMore_Reference_Specimen>?;  # Specimen imaged
    fhir:started @<dateTime>?;              # When the series started

    fhir:started @<DateTime>?;              # When the series started

    fhir:performer @<OneOrMore_ImagingStudy.series.performer>?;  # Who performed the series
    fhir:instance @<OneOrMore_ImagingStudy.series.instance>?;  # A single SOP instance from the 
                                            # series 
}  
# A single SOP instance from the series
<ImagingStudy.series.instance> EXTENDS @<BackboneElement> CLOSED {   
    fhir:uid @<id>;                         # DICOM SOP Instance UID
    fhir:sopClass @<Coding>;                # DICOM class type
    fhir:number @<unsignedInt>?;            # The number of this instance in the 
                                            # series 
    fhir:title @<string>?;                  # Description of instance
}  

#---------------------- Cardinality Types (OneOrMore) -------------------
<OneOrMore_Identifier> CLOSED {
    rdf:first @<Identifier>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Identifier> 
}
<OneOrMore_CodeableConcept> CLOSED {
    rdf:first @<CodeableConcept>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_CodeableConcept> 
}
<OneOrMore_Reference_Appointment_OR_AppointmentResponse_OR_CarePlan_OR_ServiceRequest_OR_Task> CLOSED {
    rdf:first @<Reference> AND {fhir:link 

<OneOrMore_Reference_Appointment_OR_CarePlan_OR_ServiceRequest_OR_Task> CLOSED {
    rdf:first @<Reference> AND {fhir:l 

			@<Appointment> OR 
			@<AppointmentResponse> OR 

			@<CarePlan> OR 
			@<ServiceRequest> OR 
			@<Task> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Appointment_OR_AppointmentResponse_OR_CarePlan_OR_ServiceRequest_OR_Task> 

    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Appointment_OR_CarePlan_OR_ServiceRequest_OR_Task> 

}
<OneOrMore_Reference_Procedure> CLOSED {
    rdf:first @<Reference> AND {fhir:link 

    rdf:first @<Reference> AND {fhir:l 

			@<Procedure> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Procedure> 
}
<OneOrMore_Reference_Endpoint> CLOSED {
    rdf:first @<Reference> AND {fhir:link 

    rdf:first @<Reference> AND {fhir:l 

			@<Endpoint> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Endpoint> 
}
<OneOrMore_CodeableReference> CLOSED {
    rdf:first @<CodeableReference>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_CodeableReference> 
}
<OneOrMore_Annotation> CLOSED {
    rdf:first @<Annotation>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Annotation> 
}
<OneOrMore_ImagingStudy.series> CLOSED {
    rdf:first @<ImagingStudy.series>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_ImagingStudy.series> 
}
<OneOrMore_Reference_Specimen> CLOSED {
    rdf:first @<Reference> AND {fhir:link 

    rdf:first @<Reference> AND {fhir:l 

			@<Specimen> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Specimen> 
}
<OneOrMore_ImagingStudy.series.performer> CLOSED {
    rdf:first @<ImagingStudy.series.performer>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_ImagingStudy.series.performer> 
}
<OneOrMore_ImagingStudy.series.instance> CLOSED {
    rdf:first @<ImagingStudy.series.instance>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_ImagingStudy.series.instance> 
}
#---------------------- Value Sets ------------------------
# The status of the ImagingStudy.
fhirvs:imagingstudy-status ["registered" "available" "cancelled" "entered-in-error" "unknown"]

fhirvs:imagingstudy-status ["registered" "available" "cancelled" "entered-in-error" "unknown" "inactive"]

Usage note: every effort has been made to ensure that the ShEx files are correct and useful, but they are not a normative part of the specification.