Defining URL: | https://fhir.medirecords.com/StructureDefinition/mr-immunisation |
Version: | 1.3.0 |
Name: | MRImmunisation |
Title: | MediRecords Immunisation |
Status: | Active as of 2023-09-15 01:10:47+0000 |
Definition: | MediRecords Immunisation profile to record vaccination that had been administered to the patient in context |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://fhir.medirecords.com/StructureDefinition/mr-immunisation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseImmunisation
Summary
Mandatory: 1 element
Must-Support: 16 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from AUBaseImmunisation
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | 0..1 | MRMeta | Metadata about a resource | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() | SΣC | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | S | 0..1 | string | Vaccine Serial Number Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn | ||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | 0..* | Identifier | Business identifier | |||||
![]() ![]() ![]() | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) | ||||
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(MediRecords Core Patient) | Who was immunized | ||||
![]() ![]() ![]() | S | 0..1 | Reference(MediRecords Core Encounter) | Encounter immunization was part of | ||||
![]() ![]() ![]() | Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | dateTime | Vaccine administration date | ||||
![]() ![]() ![]() | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
![]() ![]() ![]() | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
![]() ![]() ![]() | 0..1 | Reference(Location) | Where immunization occurred | |||||
![]() ![]() ![]() | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||
![]() ![]() ![]() | S | 0..1 | string | Batch Number | ||||
![]() ![]() ![]() | 0..1 | date | Vaccine expiration date | |||||
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (extensible) | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | How vaccine entered body Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred) | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | ||||
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Immunisation Administered By | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() | SΣ | 1..1 | Reference(MediRecords Core Practitioner) | Administering performer | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Immunisation Approved By | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() | SΣ | 1..1 | Reference(MediRecords Core Practitioner) | Approver | ||||
![]() ![]() ![]() | Σ | 0..1 | Annotation | Additional immunization notes | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Individual responsible for the annotation | |||||
![]() ![]() ![]() ![]() ![]() | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() ![]() | Σ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() ![]() | 0..* | CodeableConcept | Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |||||
![]() ![]() ![]() | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() ![]() | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() ![]() | C | 0..* | BackboneElement | Educational material presented to patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Educational material document identifier | |||||
![]() ![]() ![]() ![]() | 0..1 | uri | Educational material reference pointer | |||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material publication date | |||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material presentation date | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
![]() ![]() ![]() | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | When reaction started | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Observation) | Additional information on reaction | |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Indicates self-reported reaction | |||||
![]() ![]() ![]() | 0..* | BackboneElement | Protocol followed by the provider | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Name of vaccine series | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred) | |||||
![]() ![]() ![]() ![]() | 1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||||||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() ![]() ![]() | S | 0..1 | positiveInt | Dose number within series | ||||
![]() ![]() ![]() ![]() | 0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() |
This structure is derived from AUBaseImmunisation
Summary
Mandatory: 1 element
Must-Support: 16 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from AUBaseImmunisation
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | AUBaseImmunisation | An immunisation statement in an Australian healthcare context | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | 0..1 | MRMeta | Metadata about a resource | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() | SΣC | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | S | 0..1 | string | Vaccine Serial Number Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-vaccine-serial-number-extn | ||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | 0..* | Identifier | Business identifier | |||||
![]() ![]() ![]() | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Reason not done Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1 (preferred) | ||||
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | AMT Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1 (preferred) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | AIR Vaccine Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(MediRecords Core Patient) | Who was immunized | ||||
![]() ![]() ![]() | S | 0..1 | Reference(MediRecords Core Encounter) | Encounter immunization was part of | ||||
![]() ![]() ![]() | Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | dateTime | Vaccine administration date | ||||
![]() ![]() ![]() | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
![]() ![]() ![]() | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
![]() ![]() ![]() | 0..1 | Reference(Location) | Where immunization occurred | |||||
![]() ![]() ![]() | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||
![]() ![]() ![]() | S | 0..1 | string | Batch Number | ||||
![]() ![]() ![]() | 0..1 | date | Vaccine expiration date | |||||
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1 (extensible) | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | How vaccine entered body Binding: https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1 (preferred) | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by pattern:function | ||||
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: hl7VS-providerRole - AU Extended (extensible) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Immunisation Administered By | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Administering role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() | SΣ | 1..1 | Reference(MediRecords Core Practitioner) | Administering performer | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | BackboneElement | Immunisation Approved By | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Approver role Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: OP | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() | SΣ | 1..1 | Reference(MediRecords Core Practitioner) | Approver | ||||
![]() ![]() ![]() | Σ | 0..1 | Annotation | Additional immunization notes | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Individual responsible for the annotation | |||||
![]() ![]() ![]() ![]() ![]() | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() ![]() | Σ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() ![]() | 0..* | CodeableConcept | Why immunization occurred Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1 (preferred) | |||||
![]() ![]() ![]() | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() ![]() | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() ![]() | C | 0..* | BackboneElement | Educational material presented to patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Educational material document identifier | |||||
![]() ![]() ![]() ![]() | 0..1 | uri | Educational material reference pointer | |||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material publication date | |||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material presentation date | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
![]() ![]() ![]() | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | When reaction started | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Observation) | Additional information on reaction | |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Indicates self-reported reaction | |||||
![]() ![]() ![]() | 0..* | BackboneElement | Protocol followed by the provider | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Name of vaccine series | |||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1 (preferred) | |||||
![]() ![]() ![]() ![]() | 1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||||||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() ![]() ![]() | S | 0..1 | positiveInt | Dose number within series | ||||
![]() ![]() ![]() ![]() | 0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() |
Other representations of profile: CSV, Excel, Schematron
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() | |
inv-mr-meta-security-01 | error | Immunization.meta.security | Medirecords supports only U, R security code : code.exists() implies (code = 'U' or code = 'R') |