Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Immunizationrecommendation.shex

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

Raw ShEx

ShEx statement for immunizationrecommendation

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


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

# Guidance or advice relating to an immunization
<ImmunizationRecommendation> EXTENDS @<DomainResource> CLOSED {   

    a [fhir:ImmunizationRecommendation]?;
    fhir:nodeRole [fhir:treeRoot]?;

    fhir:identifier @<OneOrMore_Identifier>?;  # Business identifier
    fhir:patient @<Reference> AND {fhir:link 
    			@<Patient> ? };  # Who this profile is for
    fhir:date @<dateTime>;                  # Date recommendation(s) created
    fhir:authority @<Reference> AND {fhir:link 
    			@<Organization> ? }?;  # Who is responsible for protocol
    fhir:recommendation @<OneOrMore_ImmunizationRecommendation.recommendation>;  # Vaccine administration 
                                            # recommendations 
}  

# Dates governing proposed immunization
<ImmunizationRecommendation.recommendation.dateCriterion> EXTENDS @<BackboneElement> CLOSED {   
    fhir:code @<CodeableConcept>;           # Type of date
    fhir:value @<dateTime>;                 # Recommended date
}  

# Vaccine administration recommendations
<ImmunizationRecommendation.recommendation> EXTENDS @<BackboneElement> CLOSED {   
    fhir:vaccineCode @<OneOrMore_CodeableConcept>?;  # Vaccine  or vaccine group 
                                            # recommendation applies to 
    fhir:targetDisease @<OneOrMore_CodeableConcept>?;  # Disease to be immunized against
    fhir:contraindicatedVaccineCode @<OneOrMore_CodeableConcept>?;  # Vaccine which is contraindicated 
                                            # to fulfill the recommendation 
    fhir:forecastStatus @<CodeableConcept>;  # Vaccine recommendation status
    fhir:forecastReason @<OneOrMore_CodeableConcept>?;  # Vaccine administration status 
                                            # reason 
    fhir:dateCriterion @<OneOrMore_ImmunizationRecommendation.recommendation.dateCriterion>?;  # Dates governing proposed 
                                            # immunization 
    fhir:description @<markdown>?;          # Protocol details
    fhir:series @<string>?;                 # Name of vaccination series
    fhir:doseNumber @<string>?;             # Recommended dose number within 
                                            # series 
    fhir:seriesDoses @<string>?;            # Recommended number of doses for 
                                            # immunity 
    fhir:supportingImmunization @<OneOrMore_Reference_Immunization_OR_ImmunizationEvaluation>?;  # Past immunizations supporting 
                                            # recommendation 
    fhir:supportingPatientInformation @<OneOrMore_Reference_Resource>?;  # Patient observations supporting 
                                            # recommendation 
}  

#---------------------- Cardinality Types (OneOrMore) -------------------

<OneOrMore_Identifier> CLOSED {
    rdf:first @<Identifier>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Identifier> 
}

<OneOrMore_ImmunizationRecommendation.recommendation> CLOSED {
    rdf:first @<ImmunizationRecommendation.recommendation>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_ImmunizationRecommendation.recommendation> 
}

<OneOrMore_CodeableConcept> CLOSED {
    rdf:first @<CodeableConcept>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_CodeableConcept> 
}

<OneOrMore_ImmunizationRecommendation.recommendation.dateCriterion> CLOSED {
    rdf:first @<ImmunizationRecommendation.recommendation.dateCriterion>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_ImmunizationRecommendation.recommendation.dateCriterion> 
}

<OneOrMore_Reference_Immunization_OR_ImmunizationEvaluation> CLOSED {
    rdf:first @<Reference> AND {fhir:link 
			@<Immunization> OR 
			@<ImmunizationEvaluation> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Immunization_OR_ImmunizationEvaluation> 
}

<OneOrMore_Reference_Resource> CLOSED {
    rdf:first @<Reference> AND {fhir:link 
			@<Resource> } ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Reference_Resource> 
}


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.