Nigeria Immunization FHIR IG
0.1.0 - ci-build Nigeria flag

Nigeria Immunization FHIR IG, published by intellisoftkenya.com. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IntelliSOFT-Consulting/Nigeria-Immunization-FHIR-IG/ and changes regularly. See the Directory of published versions

Resource Profile: IMMZ.D Administer Vaccine Transaction

Official URL: http://nhin.example.ng/StructureDefinition/administer-vaccine-transaction Version: 0.1.0
Draft as of 2025-08-11 Computable Name: AdministerVaccineTransaction

Profile for a transaction Bundle used to capture vaccine administration details based on the AdministerVaccine logical model.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction
... Slices for entry SΣC 4..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource Σ 1..1 Resource A resource in the bundle
.... entry:patientEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 NEIRPatient Information about an individual or animal receiving health care services
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
....... identifier:NationalIDNo SΣ 0..1 Identifier An identifier for this patient
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/nationalID-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
....... identifier:MedicalRecordsNumber SΣ 0..1 Identifier An identifier for this patient
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/medicalrecord-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
....... identifier:ImmunizationRecordsNumber SΣ 0..1 Identifier An identifier for this patient
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/immunization-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
....... identifier:BirthCertificateNo SΣ 0..1 Identifier An identifier for this patient
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/birthCertificate-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
....... identifier:PhoneNumber SΣ 0..1 Identifier An identifier for this patient
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/phoneNumber
........ value Σ 1..1 string The value that is unique
Example General: 123456
...... active ?!Σ 0..1 boolean Whether this patient's record is in active use
...... name Σ 1..1 HumanName A name associated with the patient
....... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
....... family SΣ 1..1 string Family name (often called 'Surname')
....... given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... gender SΣ 1..1 code male | female | other | unknown
Binding: IMMZ.C.DE5 ValueSet for Gender (required)
...... birthDate SΣ 1..1 date The date of birth for the individual
...... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
....... deceasedBoolean boolean
....... deceasedDateTime dateTime
...... address SΣ 0..* Address An address for the individual
....... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
....... line SΣ 1..* string The town or city where the client resides
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city SΣ 0..1 string The ward where the client lives
Example General: Erewhon
....... district SΣ 1..1 string Local Government Authority where the client lives
Example General: Madison
....... state SΣ 1..1 string The state where the client lives
...... contact SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name 0..1 HumanName A name associated with the contact person
........ use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
........ given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
....... telecom S 0..* ContactPoint A contact detail for the person
...... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
....... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
.... entry:immunizationEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 NEIRImmunization Immunization event information
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier S 0..* Identifier Business identifier
...... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Required Pattern: completed
...... vaccineCode SΣ 1..1 CodeableConcept Vaccine Administered
Binding: IMMZ.D.DE10 ValueSet for Vaccine Type (required)
...... patient SΣ 1..1 Reference(Patient Profile - NEIR) Who was immunized
...... occurrence[x] Σ 1..1 dateTime Vaccine administration date
...... location S 1..1 Reference(NEIRLocation Profile) Where Vaccination was administered
....... display Σ 1..1 string Text alternative for the resource
...... manufacturer S 1..1 Reference(Organization) Vaccine manufacturer
....... reference SΣC 1..1 string Manufacturer ID
....... display SΣ 1..1 string Name of the Manufacturer
...... lotNumber S 1..1 string Vaccine batch number
...... expirationDate S 1..1 date Vaccine expiration date
...... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: IMMZ.D.DE21 ValueSet for Site Administered (required)
...... route 1..1 CodeableConcept How vaccine entered body
Binding: IMMZ.D.DE27 ValueSet for Route of Administration (required)
...... doseQuantity S 1..1 SimpleQuantity Amount of vaccine administered
...... performer SΣ 1..* BackboneElement Who performed event
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... actor SΣ 1..1 Reference(NEIRPractitioner Profile) Individual or organization who was performing
........ display SΣ 0..1 string Vaccinator Name
...... isSubpotent ?!Σ 0..1 boolean Dose potency
...... protocolApplied S 0..* BackboneElement Protocol followed by the provider
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... targetDisease S 1..1 CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
....... doseNumber[x] 1..1 Dose number within series
........ doseNumberPositiveInt positiveInt
........ doseNumberString string
.... entry:practitionerEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 NEIRPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier Σ 1..1 Identifier An identifier for the person as this agent
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value e.g a Registry URL
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique from the namespace
Example General: 123456
...... name Σ 1..* HumanName The name(s) associated with the practitioner
....... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
....... family Σ 1..1 string Family name (often called 'Surname')
....... given Σ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... telecom Σ 1..* ContactPoint A contact detail for the practitioner (that apply to all roles)
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... birthDate SΣ 0..1 date The date on which the practitioner was born
.... entry:organizationEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 NEIROrganization A grouping of people or organizations with a common purpose
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier SΣC 1..* Identifier Identifies this organization across multiple systems
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
...... type Σ 1..1 CodeableConcept Kind of organization
Binding: IMMZ.D.DE2 ValueSet for Facility Type (required)
...... name SΣC 1..1 string Name used for the organization
...... address SC 1..* Address An address for the organization
Constraints: org-2
....... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
....... line Σ 1..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ 1..1 string Name of city, town etc.
Example General: Erewhon
....... state Σ 1..1 string Sub-unit of country (abbreviations ok)
....... country Σ 1..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredFixed Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:NationalIDNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:MedicalRecordsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:ImmunizationRecordsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:BirthCertificateNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:PhoneNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.genderrequiredGenderVS
http://nhin.example.ng/ValueSet/gender-vs
From this IG
Bundle.entry:patientEntry.resource.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.vaccineCoderequiredIMMZFVaccineType
http://nhin.example.ng/ValueSet/IMMZFVaccineType
From this IG
Bundle.entry:immunizationEntry.resource.siterequiredIMMZDSiteAdministered
http://nhin.example.ng/ValueSet/IMMZDSiteAdministered
From this IG
Bundle.entry:immunizationEntry.resource.routerequiredIMMZDRouteOfAdministration
http://nhin.example.ng/ValueSet/IMMZDRouteOfAdministration
From this IG
Bundle.entry:immunizationEntry.resource.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.typerequiredIMMZDFacilityType
http://nhin.example.ng/ValueSet/IMMZDFacilityType
From this IG
Bundle.entry:organizationEntry.resource.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:patientEntry, Bundle.entry:immunizationEntry, Bundle.entry:practitionerEntry, Bundle.entry:organizationEntrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:patientEntry, Bundle.entry:immunizationEntry, Bundle.entry:practitionerEntry, Bundle.entry:organizationEntryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-2errorBundle.entry:organizationEntry.resource.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
pat-1errorBundle.entry:patientEntry.resource.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle Contains a collection of resources
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: transaction
... Slices for entry S 4..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
.... entry:All Slices Content/Rules for all slices
..... resource 1..1 Resource A resource in the bundle
.... entry:patientEntry 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 NEIRPatient Information about an individual or animal receiving health care services
...... name 1..1 HumanName A name associated with the patient
.... entry:immunizationEntry 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 NEIRImmunization Immunization event information
...... status 1..1 code completed | entered-in-error | not-done
Required Pattern: completed
...... vaccineCode 1..1 CodeableConcept Vaccine Administered
Binding: IMMZ.D.DE10 ValueSet for Vaccine Type (required)
...... location
....... display 1..1 string Text alternative for the resource
...... route 1..1 CodeableConcept How vaccine entered body
Binding: IMMZ.D.DE27 ValueSet for Route of Administration (required)
.... entry:practitionerEntry 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 NEIRPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
...... identifier 1..1 Identifier An identifier for the person as this agent
.... entry:organizationEntry 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 NEIROrganization A grouping of people or organizations with a common purpose
...... type 1..1 CodeableConcept Kind of organization
Binding: IMMZ.D.DE2 ValueSet for Facility Type (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Bundle.entry:immunizationEntry.resource.vaccineCoderequiredIMMZFVaccineType
http://nhin.example.ng/ValueSet/IMMZFVaccineType
From this IG
Bundle.entry:immunizationEntry.resource.routerequiredIMMZDRouteOfAdministration
http://nhin.example.ng/ValueSet/IMMZDRouteOfAdministration
From this IG
Bundle.entry:organizationEntry.resource.typerequiredIMMZDFacilityType
http://nhin.example.ng/ValueSet/IMMZDFacilityType
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry SΣC 4..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:patientEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 NEIRPatient Information about an individual or animal receiving health care services
...... id Σ 0..1 id Logical id of this artifact
...... meta Σ 0..1 Meta Metadata about the resource
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
...... contained 0..* Resource Contained, inline Resources
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
....... identifier:NationalIDNo SΣ 0..1 Identifier An identifier for this patient
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/nationalID-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... identifier:MedicalRecordsNumber SΣ 0..1 Identifier An identifier for this patient
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/medicalrecord-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... identifier:ImmunizationRecordsNumber SΣ 0..1 Identifier An identifier for this patient
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/immunization-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... identifier:BirthCertificateNo SΣ 0..1 Identifier An identifier for this patient
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/birthCertificate-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... identifier:PhoneNumber SΣ 0..1 Identifier An identifier for this patient
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/phoneNumber
........ value Σ 1..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... active ?!Σ 0..1 boolean Whether this patient's record is in active use
...... name Σ 1..1 HumanName A name associated with the patient
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
....... text Σ 0..1 string Text representation of the full name
....... family SΣ 1..1 string Family name (often called 'Surname')
....... given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
....... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
....... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
....... period Σ 0..1 Period Time period when name was/is in use
...... telecom Σ 0..* ContactPoint A contact detail for the individual
...... gender SΣ 1..1 code male | female | other | unknown
Binding: IMMZ.C.DE5 ValueSet for Gender (required)
...... birthDate SΣ 1..1 date The date of birth for the individual
...... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
....... deceasedBoolean boolean
....... deceasedDateTime dateTime
...... address SΣ 0..* Address An address for the individual
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
....... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
....... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
....... line SΣ 1..* string The town or city where the client resides
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city SΣ 0..1 string The ward where the client lives
Example General: Erewhon
....... district SΣ 1..1 string Local Government Authority where the client lives
Example General: Madison
....... state SΣ 1..1 string The state where the client lives
....... postalCode Σ 0..1 string Postal code for area
Example General: 9132
....... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
....... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
...... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
....... multipleBirthBoolean boolean
....... multipleBirthInteger integer
...... photo 0..* Attachment Image of the patient
...... contact SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
....... name 0..1 HumanName A name associated with the contact person
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
........ text Σ 0..1 string Text representation of the full name
........ family Σ 0..1 string Family name (often called 'Surname')
........ given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
........ prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
........ suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
........ period Σ 0..1 Period Time period when name was/is in use
....... telecom S 0..* ContactPoint A contact detail for the person
....... address 0..1 Address Address for the contact person
....... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
....... organization C 0..1 Reference(Organization) Organization that is associated with the contact
....... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
...... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
....... preferred 0..1 boolean Language preference indicator
...... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
...... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
...... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
....... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:immunizationEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 NEIRImmunization Immunization event information
...... id Σ 0..1 id Logical id of this artifact
...... meta Σ 0..1 Meta Metadata about the resource
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
...... contained 0..* Resource Contained, inline Resources
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier S 0..* Identifier Business identifier
...... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Required Pattern: completed
...... statusReason 0..1 CodeableConcept Reason not done
Binding: NEIR ValueSet for Immunization Not Done (required)
...... vaccineCode SΣ 1..1 CodeableConcept Vaccine Administered
Binding: IMMZ.D.DE10 ValueSet for Vaccine Type (required)
...... patient SΣ 1..1 Reference(Patient Profile - NEIR) Who was immunized
...... encounter 0..1 Reference(Encounter) Encounter immunization was part of
...... occurrence[x] Σ 1..1 dateTime Vaccine administration date
...... recorded 0..1 dateTime When the immunization was first captured in the subject's record
...... primarySource Σ 0..1 boolean Indicates context the data was recorded in
...... reportOrigin 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.
...... location S 1..1 Reference(NEIRLocation Profile) Where Vaccination was administered
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
....... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
....... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
....... display Σ 1..1 string Text alternative for the resource
...... manufacturer S 1..1 Reference(Organization) Vaccine manufacturer
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... reference SΣC 1..1 string Manufacturer ID
....... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
....... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
....... display SΣ 1..1 string Name of the Manufacturer
...... lotNumber S 1..1 string Vaccine batch number
...... expirationDate S 1..1 date Vaccine expiration date
...... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: IMMZ.D.DE21 ValueSet for Site Administered (required)
...... route 1..1 CodeableConcept How vaccine entered body
Binding: IMMZ.D.DE27 ValueSet for Route of Administration (required)
...... doseQuantity S 1..1 SimpleQuantity Amount of vaccine administered
...... performer SΣ 1..* BackboneElement Who performed event
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... function Σ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
....... actor SΣ 1..1 Reference(NEIRPractitioner Profile) Individual or organization who was performing
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
........ type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
........ identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
........ display SΣ 0..1 string Vaccinator Name
...... note Σ 0..* Annotation Additional immunization notes
...... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (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: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
...... education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... documentType 0..1 string Educational material document identifier
....... reference 0..1 uri Educational material reference pointer
....... publicationDate 0..1 dateTime Educational material publication date
....... presentationDate 0..1 dateTime Educational material presentation date
...... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
...... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
...... reaction 0..* BackboneElement Details of a reaction that follows immunization
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... date 0..1 dateTime When reaction started
....... detail 0..1 Reference(Observation) Additional information on reaction
....... reported 0..1 boolean Indicates self-reported reaction
...... protocolApplied S 0..* BackboneElement Protocol followed by the provider
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... series 0..1 string Name of vaccine series
....... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
....... targetDisease S 1..1 CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
....... doseNumber[x] 1..1 Dose number within series
........ doseNumberPositiveInt positiveInt
........ doseNumberString string
....... seriesDoses[x] 0..1 Recommended number of doses for immunity
........ seriesDosesPositiveInt positiveInt
........ seriesDosesString string
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:practitionerEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 NEIRPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
...... id Σ 0..1 id Logical id of this artifact
...... meta Σ 0..1 Meta Metadata about the resource
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
...... contained 0..* Resource Contained, inline Resources
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier Σ 1..1 Identifier An identifier for the person as this agent
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value e.g a Registry URL
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique from the namespace
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... active Σ 0..1 boolean Whether this practitioner's record is in active use
...... name Σ 1..* HumanName The name(s) associated with the practitioner
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
....... text Σ 0..1 string Text representation of the full name
....... family Σ 1..1 string Family name (often called 'Surname')
....... given Σ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
....... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
....... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
....... period Σ 0..1 Period Time period when name was/is in use
...... telecom Σ 1..* ContactPoint A contact detail for the practitioner (that apply to all roles)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
...... address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
...... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
...... birthDate SΣ 0..1 date The date on which the practitioner was born
...... photo 0..* Attachment Image of the person
...... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... identifier 0..* Identifier An identifier for this qualification for the practitioner
....... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
....... period 0..1 Period Period during which the qualification is valid
....... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
...... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:organizationEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 NEIROrganization A grouping of people or organizations with a common purpose
...... id Σ 0..1 id Logical id of this artifact
...... meta Σ 0..1 Meta Metadata about the resource
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
...... contained 0..* Resource Contained, inline Resources
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier SΣC 1..* Identifier Identifies this organization across multiple systems
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
...... type Σ 1..1 CodeableConcept Kind of organization
Binding: IMMZ.D.DE2 ValueSet for Facility Type (required)
...... name SΣC 1..1 string Name used for the organization
...... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
...... telecom C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
...... address SC 1..* Address An address for the organization
Constraints: org-2
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
....... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
....... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
....... line Σ 1..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ 1..1 string Name of city, town etc.
Example General: Erewhon
....... district Σ 0..1 string District name (aka county)
Example General: Madison
....... state Σ 1..1 string Sub-unit of country (abbreviations ok)
....... postalCode Σ 0..1 string Postal code for area
Example General: 9132
....... country Σ 1..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
....... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
...... contact 0..* BackboneElement Contact for the organization for a certain purpose
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
....... name 0..1 HumanName A name associated with the contact
....... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
....... address 0..1 Address Visiting or postal addresses for the contact
...... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredFixed Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:patientEntry.resource.identifier:NationalIDNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:NationalIDNo.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:MedicalRecordsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:MedicalRecordsNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:ImmunizationRecordsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:ImmunizationRecordsNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:BirthCertificateNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:BirthCertificateNo.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:PhoneNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:PhoneNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:patientEntry.resource.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.genderrequiredGenderVS
http://nhin.example.ng/ValueSet/gender-vs
From this IG
Bundle.entry:patientEntry.resource.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
From the FHIR Standard
Bundle.entry:patientEntry.resource.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
From the FHIR Standard
Bundle.entry:patientEntry.resource.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:patientEntry.resource.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:immunizationEntry.resource.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.statusReasonrequiredNEIRImmunizationNotDoneReasonsVS(a valid code from NEIR CodeSystem for Immunization Not Done)
http://nhin.example.ng/ValueSet/NEIRImmunizationNotDoneReasonsVS
From this IG
Bundle.entry:immunizationEntry.resource.vaccineCoderequiredIMMZFVaccineType
http://nhin.example.ng/ValueSet/IMMZFVaccineType
From this IG
Bundle.entry:immunizationEntry.resource.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.location.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.manufacturer.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.siterequiredIMMZDSiteAdministered
http://nhin.example.ng/ValueSet/IMMZDSiteAdministered
From this IG
Bundle.entry:immunizationEntry.resource.routerequiredIMMZDRouteOfAdministration
http://nhin.example.ng/ValueSet/IMMZDRouteOfAdministration
From this IG
Bundle.entry:immunizationEntry.resource.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From the FHIR Standard
Bundle.entry:immunizationEntry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:immunizationEntry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:practitionerEntry.resource.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.communicationpreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:practitionerEntry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:organizationEntry.resource.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:organizationEntry.resource.typerequiredIMMZDFacilityType
http://nhin.example.ng/ValueSet/IMMZDFacilityType
From this IG
Bundle.entry:organizationEntry.resource.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
From the FHIR Standard
Bundle.entry:organizationEntry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:patientEntry, Bundle.entry:immunizationEntry, Bundle.entry:practitionerEntry, Bundle.entry:organizationEntrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:patientEntry, Bundle.entry:immunizationEntry, Bundle.entry:practitionerEntry, Bundle.entry:organizationEntryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorBundle.entry:immunizationEntry.resource.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()
org-2errorBundle.entry:organizationEntry.resource.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorBundle.entry:organizationEntry.resource.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
pat-1errorBundle.entry:patientEntry.resource.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Bundle

Summary

Mandatory: 7 elements
Must-Support: 1 element
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction
... Slices for entry SΣC 4..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource Σ 1..1 Resource A resource in the bundle
.... entry:patientEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 NEIRPatient Information about an individual or animal receiving health care services
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
....... identifier:NationalIDNo SΣ 0..1 Identifier An identifier for this patient
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/nationalID-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
....... identifier:MedicalRecordsNumber SΣ 0..1 Identifier An identifier for this patient
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/medicalrecord-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
....... identifier:ImmunizationRecordsNumber SΣ 0..1 Identifier An identifier for this patient
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/immunization-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
....... identifier:BirthCertificateNo SΣ 0..1 Identifier An identifier for this patient
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/birthCertificate-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
....... identifier:PhoneNumber SΣ 0..1 Identifier An identifier for this patient
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/phoneNumber
........ value Σ 1..1 string The value that is unique
Example General: 123456
...... active ?!Σ 0..1 boolean Whether this patient's record is in active use
...... name Σ 1..1 HumanName A name associated with the patient
....... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
....... family SΣ 1..1 string Family name (often called 'Surname')
....... given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... gender SΣ 1..1 code male | female | other | unknown
Binding: IMMZ.C.DE5 ValueSet for Gender (required)
...... birthDate SΣ 1..1 date The date of birth for the individual
...... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
....... deceasedBoolean boolean
....... deceasedDateTime dateTime
...... address SΣ 0..* Address An address for the individual
....... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
....... line SΣ 1..* string The town or city where the client resides
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city SΣ 0..1 string The ward where the client lives
Example General: Erewhon
....... district SΣ 1..1 string Local Government Authority where the client lives
Example General: Madison
....... state SΣ 1..1 string The state where the client lives
...... contact SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name 0..1 HumanName A name associated with the contact person
........ use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
........ given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
....... telecom S 0..* ContactPoint A contact detail for the person
...... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
....... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
.... entry:immunizationEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 NEIRImmunization Immunization event information
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier S 0..* Identifier Business identifier
...... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Required Pattern: completed
...... vaccineCode SΣ 1..1 CodeableConcept Vaccine Administered
Binding: IMMZ.D.DE10 ValueSet for Vaccine Type (required)
...... patient SΣ 1..1 Reference(Patient Profile - NEIR) Who was immunized
...... occurrence[x] Σ 1..1 dateTime Vaccine administration date
...... location S 1..1 Reference(NEIRLocation Profile) Where Vaccination was administered
....... display Σ 1..1 string Text alternative for the resource
...... manufacturer S 1..1 Reference(Organization) Vaccine manufacturer
....... reference SΣC 1..1 string Manufacturer ID
....... display SΣ 1..1 string Name of the Manufacturer
...... lotNumber S 1..1 string Vaccine batch number
...... expirationDate S 1..1 date Vaccine expiration date
...... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: IMMZ.D.DE21 ValueSet for Site Administered (required)
...... route 1..1 CodeableConcept How vaccine entered body
Binding: IMMZ.D.DE27 ValueSet for Route of Administration (required)
...... doseQuantity S 1..1 SimpleQuantity Amount of vaccine administered
...... performer SΣ 1..* BackboneElement Who performed event
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... actor SΣ 1..1 Reference(NEIRPractitioner Profile) Individual or organization who was performing
........ display SΣ 0..1 string Vaccinator Name
...... isSubpotent ?!Σ 0..1 boolean Dose potency
...... protocolApplied S 0..* BackboneElement Protocol followed by the provider
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... targetDisease S 1..1 CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
....... doseNumber[x] 1..1 Dose number within series
........ doseNumberPositiveInt positiveInt
........ doseNumberString string
.... entry:practitionerEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 NEIRPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier Σ 1..1 Identifier An identifier for the person as this agent
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value e.g a Registry URL
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique from the namespace
Example General: 123456
...... name Σ 1..* HumanName The name(s) associated with the practitioner
....... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
....... family Σ 1..1 string Family name (often called 'Surname')
....... given Σ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... telecom Σ 1..* ContactPoint A contact detail for the practitioner (that apply to all roles)
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
...... birthDate SΣ 0..1 date The date on which the practitioner was born
.... entry:organizationEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... resource 1..1 NEIROrganization A grouping of people or organizations with a common purpose
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier SΣC 1..* Identifier Identifies this organization across multiple systems
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
...... type Σ 1..1 CodeableConcept Kind of organization
Binding: IMMZ.D.DE2 ValueSet for Facility Type (required)
...... name SΣC 1..1 string Name used for the organization
...... address SC 1..* Address An address for the organization
Constraints: org-2
....... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
....... line Σ 1..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ 1..1 string Name of city, town etc.
Example General: Erewhon
....... state Σ 1..1 string Sub-unit of country (abbreviations ok)
....... country Σ 1..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredFixed Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:NationalIDNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:MedicalRecordsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:ImmunizationRecordsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:BirthCertificateNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:PhoneNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.genderrequiredGenderVS
http://nhin.example.ng/ValueSet/gender-vs
From this IG
Bundle.entry:patientEntry.resource.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.vaccineCoderequiredIMMZFVaccineType
http://nhin.example.ng/ValueSet/IMMZFVaccineType
From this IG
Bundle.entry:immunizationEntry.resource.siterequiredIMMZDSiteAdministered
http://nhin.example.ng/ValueSet/IMMZDSiteAdministered
From this IG
Bundle.entry:immunizationEntry.resource.routerequiredIMMZDRouteOfAdministration
http://nhin.example.ng/ValueSet/IMMZDRouteOfAdministration
From this IG
Bundle.entry:immunizationEntry.resource.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.typerequiredIMMZDFacilityType
http://nhin.example.ng/ValueSet/IMMZDFacilityType
From this IG
Bundle.entry:organizationEntry.resource.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:patientEntry, Bundle.entry:immunizationEntry, Bundle.entry:practitionerEntry, Bundle.entry:organizationEntrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:patientEntry, Bundle.entry:immunizationEntry, Bundle.entry:practitionerEntry, Bundle.entry:organizationEntryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-2errorBundle.entry:organizationEntry.resource.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
pat-1errorBundle.entry:patientEntry.resource.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle Contains a collection of resources
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: transaction
... Slices for entry S 4..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
.... entry:All Slices Content/Rules for all slices
..... resource 1..1 Resource A resource in the bundle
.... entry:patientEntry 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 NEIRPatient Information about an individual or animal receiving health care services
...... name 1..1 HumanName A name associated with the patient
.... entry:immunizationEntry 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 NEIRImmunization Immunization event information
...... status 1..1 code completed | entered-in-error | not-done
Required Pattern: completed
...... vaccineCode 1..1 CodeableConcept Vaccine Administered
Binding: IMMZ.D.DE10 ValueSet for Vaccine Type (required)
...... location
....... display 1..1 string Text alternative for the resource
...... route 1..1 CodeableConcept How vaccine entered body
Binding: IMMZ.D.DE27 ValueSet for Route of Administration (required)
.... entry:practitionerEntry 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 NEIRPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
...... identifier 1..1 Identifier An identifier for the person as this agent
.... entry:organizationEntry 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 NEIROrganization A grouping of people or organizations with a common purpose
...... type 1..1 CodeableConcept Kind of organization
Binding: IMMZ.D.DE2 ValueSet for Facility Type (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Bundle.entry:immunizationEntry.resource.vaccineCoderequiredIMMZFVaccineType
http://nhin.example.ng/ValueSet/IMMZFVaccineType
From this IG
Bundle.entry:immunizationEntry.resource.routerequiredIMMZDRouteOfAdministration
http://nhin.example.ng/ValueSet/IMMZDRouteOfAdministration
From this IG
Bundle.entry:organizationEntry.resource.typerequiredIMMZDFacilityType
http://nhin.example.ng/ValueSet/IMMZDFacilityType
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: transaction
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry SΣC 4..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:patientEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 NEIRPatient Information about an individual or animal receiving health care services
...... id Σ 0..1 id Logical id of this artifact
...... meta Σ 0..1 Meta Metadata about the resource
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
...... contained 0..* Resource Contained, inline Resources
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
....... identifier:NationalIDNo SΣ 0..1 Identifier An identifier for this patient
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/nationalID-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... identifier:MedicalRecordsNumber SΣ 0..1 Identifier An identifier for this patient
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/medicalrecord-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... identifier:ImmunizationRecordsNumber SΣ 0..1 Identifier An identifier for this patient
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/immunization-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... identifier:BirthCertificateNo SΣ 0..1 Identifier An identifier for this patient
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/birthCertificate-no
........ value Σ 1..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
....... identifier:PhoneNumber SΣ 0..1 Identifier An identifier for this patient
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
........ type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
........ system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://moh.nigeria/identifier/phoneNumber
........ value Σ 1..1 string The value that is unique
Example General: 123456
........ period Σ 0..1 Period Time period when id is/was valid for use
........ assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... active ?!Σ 0..1 boolean Whether this patient's record is in active use
...... name Σ 1..1 HumanName A name associated with the patient
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
....... text Σ 0..1 string Text representation of the full name
....... family SΣ 1..1 string Family name (often called 'Surname')
....... given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
....... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
....... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
....... period Σ 0..1 Period Time period when name was/is in use
...... telecom Σ 0..* ContactPoint A contact detail for the individual
...... gender SΣ 1..1 code male | female | other | unknown
Binding: IMMZ.C.DE5 ValueSet for Gender (required)
...... birthDate SΣ 1..1 date The date of birth for the individual
...... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
....... deceasedBoolean boolean
....... deceasedDateTime dateTime
...... address SΣ 0..* Address An address for the individual
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
....... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
....... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
....... line SΣ 1..* string The town or city where the client resides
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city SΣ 0..1 string The ward where the client lives
Example General: Erewhon
....... district SΣ 1..1 string Local Government Authority where the client lives
Example General: Madison
....... state SΣ 1..1 string The state where the client lives
....... postalCode Σ 0..1 string Postal code for area
Example General: 9132
....... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
....... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
...... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
....... multipleBirthBoolean boolean
....... multipleBirthInteger integer
...... photo 0..* Attachment Image of the patient
...... contact SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
....... name 0..1 HumanName A name associated with the contact person
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
........ text Σ 0..1 string Text representation of the full name
........ family Σ 0..1 string Family name (often called 'Surname')
........ given SΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
........ prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
........ suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
........ period Σ 0..1 Period Time period when name was/is in use
....... telecom S 0..* ContactPoint A contact detail for the person
....... address 0..1 Address Address for the contact person
....... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
....... organization C 0..1 Reference(Organization) Organization that is associated with the contact
....... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
...... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
....... preferred 0..1 boolean Language preference indicator
...... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
...... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
...... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
....... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:immunizationEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 NEIRImmunization Immunization event information
...... id Σ 0..1 id Logical id of this artifact
...... meta Σ 0..1 Meta Metadata about the resource
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
...... contained 0..* Resource Contained, inline Resources
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier S 0..* Identifier Business identifier
...... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Required Pattern: completed
...... statusReason 0..1 CodeableConcept Reason not done
Binding: NEIR ValueSet for Immunization Not Done (required)
...... vaccineCode SΣ 1..1 CodeableConcept Vaccine Administered
Binding: IMMZ.D.DE10 ValueSet for Vaccine Type (required)
...... patient SΣ 1..1 Reference(Patient Profile - NEIR) Who was immunized
...... encounter 0..1 Reference(Encounter) Encounter immunization was part of
...... occurrence[x] Σ 1..1 dateTime Vaccine administration date
...... recorded 0..1 dateTime When the immunization was first captured in the subject's record
...... primarySource Σ 0..1 boolean Indicates context the data was recorded in
...... reportOrigin 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.
...... location S 1..1 Reference(NEIRLocation Profile) Where Vaccination was administered
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
....... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
....... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
....... display Σ 1..1 string Text alternative for the resource
...... manufacturer S 1..1 Reference(Organization) Vaccine manufacturer
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... reference SΣC 1..1 string Manufacturer ID
....... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
....... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
....... display SΣ 1..1 string Name of the Manufacturer
...... lotNumber S 1..1 string Vaccine batch number
...... expirationDate S 1..1 date Vaccine expiration date
...... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: IMMZ.D.DE21 ValueSet for Site Administered (required)
...... route 1..1 CodeableConcept How vaccine entered body
Binding: IMMZ.D.DE27 ValueSet for Route of Administration (required)
...... doseQuantity S 1..1 SimpleQuantity Amount of vaccine administered
...... performer SΣ 1..* BackboneElement Who performed event
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... function Σ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
....... actor SΣ 1..1 Reference(NEIRPractitioner Profile) Individual or organization who was performing
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
........ type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
........ identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
........ display SΣ 0..1 string Vaccinator Name
...... note Σ 0..* Annotation Additional immunization notes
...... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (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: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
...... education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... documentType 0..1 string Educational material document identifier
....... reference 0..1 uri Educational material reference pointer
....... publicationDate 0..1 dateTime Educational material publication date
....... presentationDate 0..1 dateTime Educational material presentation date
...... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
...... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
...... reaction 0..* BackboneElement Details of a reaction that follows immunization
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... date 0..1 dateTime When reaction started
....... detail 0..1 Reference(Observation) Additional information on reaction
....... reported 0..1 boolean Indicates self-reported reaction
...... protocolApplied S 0..* BackboneElement Protocol followed by the provider
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... series 0..1 string Name of vaccine series
....... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
....... targetDisease S 1..1 CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
....... doseNumber[x] 1..1 Dose number within series
........ doseNumberPositiveInt positiveInt
........ doseNumberString string
....... seriesDoses[x] 0..1 Recommended number of doses for immunity
........ seriesDosesPositiveInt positiveInt
........ seriesDosesString string
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:practitionerEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 NEIRPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
...... id Σ 0..1 id Logical id of this artifact
...... meta Σ 0..1 Meta Metadata about the resource
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
...... contained 0..* Resource Contained, inline Resources
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier Σ 1..1 Identifier An identifier for the person as this agent
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value e.g a Registry URL
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique from the namespace
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... active Σ 0..1 boolean Whether this practitioner's record is in active use
...... name Σ 1..* HumanName The name(s) associated with the practitioner
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
....... text Σ 0..1 string Text representation of the full name
....... family Σ 1..1 string Family name (often called 'Surname')
....... given Σ 1..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
....... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
....... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
....... period Σ 0..1 Period Time period when name was/is in use
...... telecom Σ 1..* ContactPoint A contact detail for the practitioner (that apply to all roles)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
...... address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
...... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
...... birthDate SΣ 0..1 date The date on which the practitioner was born
...... photo 0..* Attachment Image of the person
...... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... identifier 0..* Identifier An identifier for this qualification for the practitioner
....... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
....... period 0..1 Period Period during which the qualification is valid
....... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
...... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:organizationEntry ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 NEIROrganization A grouping of people or organizations with a common purpose
...... id Σ 0..1 id Logical id of this artifact
...... meta Σ 0..1 Meta Metadata about the resource
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
...... contained 0..* Resource Contained, inline Resources
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
...... identifier SΣC 1..* Identifier Identifies this organization across multiple systems
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
...... type Σ 1..1 CodeableConcept Kind of organization
Binding: IMMZ.D.DE2 ValueSet for Facility Type (required)
...... name SΣC 1..1 string Name used for the organization
...... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
...... telecom C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
....... value Σ 1..1 string The actual contact point details
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
....... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
....... period Σ 0..1 Period Time period when the contact point was/is in use
...... address SC 1..* Address An address for the organization
Constraints: org-2
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
....... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
....... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
....... line Σ 1..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ 1..1 string Name of city, town etc.
Example General: Erewhon
....... district Σ 0..1 string District name (aka county)
Example General: Madison
....... state Σ 1..1 string Sub-unit of country (abbreviations ok)
....... postalCode Σ 0..1 string Postal code for area
Example General: 9132
....... country Σ 1..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
....... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
...... contact 0..* BackboneElement Contact for the organization for a certain purpose
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
....... name 0..1 HumanName A name associated with the contact
....... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
....... address 0..1 Address Visiting or postal addresses for the contact
...... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredFixed Value: transaction
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:patientEntry.resource.identifier:NationalIDNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:NationalIDNo.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:MedicalRecordsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:MedicalRecordsNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:ImmunizationRecordsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:ImmunizationRecordsNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:BirthCertificateNo.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:BirthCertificateNo.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:PhoneNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.identifier:PhoneNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:patientEntry.resource.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.genderrequiredGenderVS
http://nhin.example.ng/ValueSet/gender-vs
From this IG
Bundle.entry:patientEntry.resource.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
From the FHIR Standard
Bundle.entry:patientEntry.resource.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
From the FHIR Standard
Bundle.entry:patientEntry.resource.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.resource.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:patientEntry.resource.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:patientEntry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:immunizationEntry.resource.statusrequiredPattern Value: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.statusReasonrequiredNEIRImmunizationNotDoneReasonsVS(a valid code from NEIR CodeSystem for Immunization Not Done)
http://nhin.example.ng/ValueSet/NEIRImmunizationNotDoneReasonsVS
From this IG
Bundle.entry:immunizationEntry.resource.vaccineCoderequiredIMMZFVaccineType
http://nhin.example.ng/ValueSet/IMMZFVaccineType
From this IG
Bundle.entry:immunizationEntry.resource.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.location.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.manufacturer.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.siterequiredIMMZDSiteAdministered
http://nhin.example.ng/ValueSet/IMMZDSiteAdministered
From this IG
Bundle.entry:immunizationEntry.resource.routerequiredIMMZDRouteOfAdministration
http://nhin.example.ng/ValueSet/IMMZDRouteOfAdministration
From this IG
Bundle.entry:immunizationEntry.resource.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
From the FHIR Standard
Bundle.entry:immunizationEntry.resource.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From the FHIR Standard
Bundle.entry:immunizationEntry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:immunizationEntry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:practitionerEntry.resource.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.qualification.codeexamplev2.0360.2.7(a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
From the FHIR Standard
Bundle.entry:practitionerEntry.resource.communicationpreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:practitionerEntry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:practitionerEntry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:organizationEntry.resource.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Bundle.entry:organizationEntry.resource.typerequiredIMMZDFacilityType
http://nhin.example.ng/ValueSet/IMMZDFacilityType
From this IG
Bundle.entry:organizationEntry.resource.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.resource.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
From the FHIR Standard
Bundle.entry:organizationEntry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:organizationEntry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:patientEntry, Bundle.entry:immunizationEntry, Bundle.entry:practitionerEntry, Bundle.entry:organizationEntrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:patientEntry, Bundle.entry:immunizationEntry, Bundle.entry:practitionerEntry, Bundle.entry:organizationEntryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorBundle.entry:immunizationEntry.resource.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()
org-2errorBundle.entry:organizationEntry.resource.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorBundle.entry:organizationEntry.resource.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
pat-1errorBundle.entry:patientEntry.resource.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Bundle

Summary

Mandatory: 7 elements
Must-Support: 1 element
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry

 

Other representations of profile: CSV, Excel, Schematron