Standard Health Record FHIR Implementation Guide

SHR ImmunizationRequested Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-immunization-ImmunizationRequested

An immunization that is proposed or planned for the subject.

This profile builds on Basic.

This profile was published on Tue Feb 27 00:00:00 EST 2018 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR ImmunizationRequested Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-immunization-ImmunizationRequested"}]}
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
... shr-immunization-Vaccine-extension 1..1(Complex)SHR Vaccine Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-immunization-Vaccine-extension
... shr-entity-BodySite-extension 0..1Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-medication-RouteIntoBody-extension 0..1CodeableConceptSHR RouteIntoBody Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-RouteIntoBody-extension
Binding: SNOMED CT Route Codes (required)
... shr-medication-DoseAmount-extension 0..1Reference(SHR SimpleQuantity Profile), SHR Range ProfileSHR DoseAmount Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-DoseAmount-extension
... shr-action-Outcome-extension 0..*(Complex)SHR Outcome Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Outcome-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR ImmunizationRequested Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
... shr-immunization-Vaccine-extension 1..1(Complex)SHR Vaccine Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-immunization-Vaccine-extension
... shr-entity-BodySite-extension 0..1Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-medication-RouteIntoBody-extension 0..1CodeableConceptSHR RouteIntoBody Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-RouteIntoBody-extension
Binding: SNOMED CT Route Codes (required)
... shr-medication-DoseAmount-extension 0..1Reference(SHR SimpleQuantity Profile), SHR Range ProfileSHR DoseAmount Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-DoseAmount-extension
... shr-action-Outcome-extension 0..*(Complex)SHR Outcome Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Outcome-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-immunization-ImmunizationRequested"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR ImmunizationRequested Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-immunization-ImmunizationRequested"}]}
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
... shr-immunization-Vaccine-extension 1..1(Complex)SHR Vaccine Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-immunization-Vaccine-extension
... shr-entity-BodySite-extension 0..1Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-medication-RouteIntoBody-extension 0..1CodeableConceptSHR RouteIntoBody Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-RouteIntoBody-extension
Binding: SNOMED CT Route Codes (required)
... shr-medication-DoseAmount-extension 0..1Reference(SHR SimpleQuantity Profile), SHR Range ProfileSHR DoseAmount Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-DoseAmount-extension
... shr-action-Outcome-extension 0..*(Complex)SHR Outcome Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Outcome-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR ImmunizationRequested Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
... shr-immunization-Vaccine-extension 1..1(Complex)SHR Vaccine Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-immunization-Vaccine-extension
... shr-entity-BodySite-extension 0..1Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-medication-RouteIntoBody-extension 0..1CodeableConceptSHR RouteIntoBody Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-RouteIntoBody-extension
Binding: SNOMED CT Route Codes (required)
... shr-medication-DoseAmount-extension 0..1Reference(SHR SimpleQuantity Profile), SHR Range ProfileSHR DoseAmount Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-DoseAmount-extension
... shr-action-Outcome-extension 0..*(Complex)SHR Outcome Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Outcome-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-immunization-ImmunizationRequested"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Basic.languageCommon LanguagesextensibleCommon Languages
Basic.codeBasic Resource TypesexampleBasic Resource Types

 

Constraints

IdPathDetailsRequirements
dom-2BasicIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1BasicIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4BasicIf 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-3BasicIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()