This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions


Public Health and Emergency Response Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Patient

Raw ShEx

ShEx statement for immunizationevaluation

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 <code.shex>
IMPORT <string.shex>
IMPORT <Patient.shex>
IMPORT <dateTime.shex>
IMPORT <markdown.shex>
IMPORT <Reference.shex>
IMPORT <Identifier.shex>
IMPORT <Organization.shex>
IMPORT <Immunization.shex>
IMPORT <DomainResource.shex>
IMPORT <CodeableConcept.shex>

start=@<ImmunizationEvaluation> AND {fhir:nodeRole [fhir:treeRoot]}

# Immunization evaluation information
<ImmunizationEvaluation> EXTENDS @<DomainResource> CLOSED {   
    a [fhir:ImmunizationEvaluation]?;fhir:nodeRole [fhir:treeRoot]?;

    fhir:identifier @<OneOrMore_Identifier>?;  # Business identifier
    fhir:status @<code> AND
    	{fhir:v @fhirvs:immunization-evaluation-status};  # completed | entered-in-error
    fhir:patient @<Reference> AND {fhir:link 
    			@<Patient> ? };  # Who this evaluation is for
    fhir:date @<dateTime>?;                 # Date evaluation was performed
    fhir:authority @<Reference> AND {fhir:link 
    			@<Organization> ? }?;  # Who is responsible for publishing 
                                            # the recommendations 
    fhir:targetDisease @<CodeableConcept>;  # The vaccine preventable disease 
                                            # schedule being evaluated 
    fhir:immunizationEvent @<Reference> AND {fhir:link 
    			@<Immunization> ? };  # Immunization being evaluated
    fhir:doseStatus @<CodeableConcept>;     # Status of the dose relative to 
                                            # published recommendations 
    fhir:doseStatusReason @<OneOrMore_CodeableConcept>?;  # Reason why the doese is considered 
                                            # valid, invalid or some other 
                                            # status 
    fhir:description @<markdown>?;          # Evaluation notes
    fhir:series @<string>?;                 # Name of vaccine series
    fhir:doseNumber @<string>?;             # Dose number within series
    fhir:seriesDoses @<string>?;            # Recommended number of doses for 
                                            # immunity 

#---------------------- 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> 

#---------------------- Value Sets ------------------------

# The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the current status of the evaluation for vaccine administration event.
fhirvs:immunization-evaluation-status ["completed" "entered-in-error"]

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.