| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments |
|---|
  Immunization | C | 0..* | Immunization | Argonaut Immunization Profile
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
| C | 0..* | Immunization | Immunization event information
us-core-5: SHOULD have a translation to the NDC value set
| - Elements differ in short: 'Argonaut Immunization Profile' vs 'Immunization event information'
- Elements differ in definition: 'Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.' vs '\-'
|
 id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | - Elements differ in comments: 'The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.' vs 'The only time that a resource does not have an id is when it is being submitted to the server using a create operation.'
|
| meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | - Elements differ in definition: 'The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.' vs 'The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.'
|
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | - Elements differ in definition: 'A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.' vs 'A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.'
- Elements differ in comments: 'Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.' vs 'Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.'
|
| language | | 0..1 | code | Language of the resource content
Binding: todo (required): A human language.
| | 0..1 | code | Language of the resource content
Binding: todo (preferred): A human language.
| - Elements differ in comments: 'Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).' vs 'Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).'
|
| text | | 0..1 | Narrative | Text summary of the resource, for human interpretation | | 0..1 | Narrative | Text summary of the resource, for human interpretation | - Elements differ in definition: 'A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.' vs 'A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.'
- Elements differ in comments: 'Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.' vs 'Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.'
|
| contained | | 0..* | Resource | Contained, inline Resources
| | 0..* | Resource | Contained, inline Resources
| - Elements differ in comments: 'This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.' vs 'This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.'
|
 extension | | 0..* | Extension | Additional Content defined by implementations
| | 0..* | Extension | Additional content defined by implementations
| - Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.'
|
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
| ?! | 0..* | Extension | Extensions that cannot be ignored
| - Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.' vs 'May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).'
|
| identifier | | 0..* | Identifier | Business identifier
| | 0..* | Identifier | Business identifier
| |
| status | ?!S | 1..1 | code | in-progress | on-hold | completed | entered-in-error | stopped
Binding: todo (required): Constrained list of immunizaiotn status
| ?!SΣ | 1..1 | code | (USCDI) completed | entered-in-error | not-done
Binding: todo (required) | - Elements differ in short: 'in-progress | on-hold | completed | entered-in-error | stopped' vs '(USCDI) completed | entered-in-error | not-done'
- Elements differ in definition: 'Indicates the current status of the vaccination event.' vs 'Indicates the current status of the immunization event.'
- Elements differ in comments: 'Will generally be set to show that the immunization has been completed.' vs 'Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.'
|
| date | S | 1..1 | dateTime | Vaccination administration date | | | | | |
| vaccineCode | SC | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX)
Binding: todo (extensible): The CVX (vaccine administered) code system
arg-1: SHOULD have a translation to the to the NDC value set | SΣC | 1..1 | CodeableConcept | (USCDI) Vaccine Product Type (bind to CVX)
Binding: todo (extensible) | - Elements differ in short: 'Vaccine Product Type (bind to CVX)' vs '(USCDI) Vaccine Product Type (bind to CVX)'
- Unable to resolve left value set http://hl7.org/fhir/ValueSet/daf-cvx at Immunization.vaccineCode
|
| patient | S | 1..1 | Reference(http://fhir.org/guides/argonaut/StructureDefinition/argo-patient) | Who was immunized | SΣ | 1..1 | Reference(http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient) | (USCDI) Who was immunized | - Elements differ in short: 'Who was immunized' vs '(USCDI) Who was immunized'
|
| wasNotGiven | ?!S | 1..1 | boolean | Flag for whether immunization was given | | | | | |
| reported | S | 1..1 | boolean | Indicates a self-reported record | | | | | |
| performer | | 0..1 | Reference(Practitioner) | Who administered vaccine | Σ | 0..* | BackboneElement | Who performed event
| - Elements differ in short: 'Who administered vaccine' vs 'Who performed event'
- Elements differ in definition: 'Clinician who administered the vaccine.' vs 'Indicates who performed the immunization event.'
- Element maximum cardinalities differ: '1' vs '2147483647'
|
 id | | 0..1 | string | Unique id for inter-element referencing | | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | | 0..* | Extension | Additional content defined by implementations
Slice: Unordered, Open by value:url
| | 0..* | Extension | Additional content defined by implementations
| |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
| ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
| |
| function | | | | | Σ | 0..1 | CodeableConcept | What type of performance was done
Binding: todo (extensible): The role a practitioner or organization plays in the immunization event.
| |
 actor | | | | | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |
| requester | | 0..1 | Reference(Practitioner) | Who ordered vaccination | | | | | |
| encounter | | 0..1 | Reference(Encounter) | Encounter administered as part of | | 0..1 | Reference(Encounter) | Encounter immunization was part of | - Elements differ in short: 'Encounter administered as part of' vs 'Encounter immunization was part of'
|
| manufacturer | | 0..1 | Reference(Organization) | Vaccine manufacturer | | 0..1 | Reference(Organization) | Vaccine manufacturer | |
| location | | 0..1 | Reference(Location) | Where vaccination occurred | | 0..1 | Reference(Location) | Where immunization occurred | - Elements differ in short: 'Where vaccination occurred' vs 'Where immunization occurred'
|
| lotNumber | | 0..1 | string | Vaccine lot number | | 0..1 | string | Vaccine lot number | |
| expirationDate | | 0..1 | date | Vaccine expiration date | | 0..1 | date | Vaccine expiration date | |
| site | | 0..1 | CodeableConcept | Body site vaccine was administered
Binding: todo (example): The site at which the vaccine was administered
| | 0..1 | CodeableConcept | Body site vaccine was administered
Binding: todo (example): The site at which the vaccine was administered.
| - Elements differ in binding.description: 'The site at which the vaccine was administered' vs 'The site at which the vaccine was administered.'
|
| route | | 0..1 | CodeableConcept | How vaccine entered body
Binding: todo (example): The route by which the vaccine was administered
| | 0..1 | CodeableConcept | How vaccine entered body
Binding: todo (example): The route by which the vaccine was administered.
| - Elements differ in binding.description: 'The route by which the vaccine was administered' vs 'The route by which the vaccine was administered.'
|
| doseQuantity | | 0..1 | Quantity | Amount of vaccine administered | | 0..1 | Quantity | Amount of vaccine administered | |
| note | Σ | 0..* | Annotation | Vaccination notes
| Σ | 0..* | Annotation | Additional immunization notes
| - Elements differ in short: 'Vaccination notes' vs 'Additional immunization notes'
|
| explanation | | 0..1 | BackboneElement | Administration/non-administration reasons | | | | | |
| reaction | | 0..* | BackboneElement | Details of a reaction that follows immunization
| | 0..* | BackboneElement | Details of a reaction that follows immunization
| - Elements differ in comments: 'A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.' vs 'A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.'
|
| id | | 0..1 | id | xml:id (or equivalent in JSON) | | 0..1 | string | Unique id for inter-element referencing | - Elements differ in short: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing'
- Elements differ in definition: 'unique id for the element within a resource (for internal references).' vs 'Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.'
|
| extension | | 0..* | Extension | Additional Content defined by implementations
| | 0..* | Extension | Additional content defined by implementations
| - Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.'
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
| ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
| - Elements differ in short: 'Extensions that cannot be ignored' vs 'Extensions that cannot be ignored even if unrecognized'
- Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).'
|
| date | | 0..1 | dateTime | When reaction started | | 0..1 | dateTime | When reaction started | |
| detail | | 0..1 | Reference(Observation) | Additional information on reaction | | 0..1 | Reference(Observation) | Additional information on reaction | |
| reported | | 0..1 | boolean | Indicates self-reported reaction | | 0..1 | boolean | Indicates self-reported reaction | |
| vaccinationProtocol | | 0..* | BackboneElement | What protocol was followed
| | | | | |
| statusReason | | | | | S | 0..1 | CodeableConcept | (USCDI) Reason not done
Binding: todo (example) | |
| occurrence[x] | | | | | SΣ | 1..1 | dateTime S, string | (USCDI) Vaccine administration date | |
| recorded | | | | | | 0..1 | dateTime | When the immunization was first captured in the subject's record | |
| primarySource | | | | | SΣ | 0..1 | boolean | (USCDI) Indicates context the data was recorded in | |
| reportOrigin | | | | | | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record
Binding: todo (example): The source of the data for a record which is not from a primary source.
| |
| reasonCode | | | | | | 0..* | CodeableConcept | Why immunization occurred
Binding: todo (example): The reason why a vaccine was administered.
| |
| reasonReference | | | | | | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred
| |
| isSubpotent | | | | | ?!Σ | 0..1 | boolean | Dose potency | |
| subpotentReason | | | | | | 0..* | CodeableConcept | Reason for being subpotent
Binding: todo (example): The reason why a dose is considered to be subpotent.
| |
| education | | | | | C | 0..* | BackboneElement | Educational material presented to patient
| |
| programEligibility | | | | | | 0..* | CodeableConcept | Patient eligibility for a vaccination program
Binding: todo (example): The patient's eligibility for a vaccation program.
| |
| fundingSource | | | | | | 0..1 | CodeableConcept | Funding source for the vaccine
Binding: todo (example): The source of funding used to purchase the vaccine administered.
| |
| protocolApplied | | | | | | 0..* | BackboneElement | Protocol followed by the provider
| |
Documentation for this format |