Universal API Implementation Guide - Local Development build (v1.1.20) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: UAPI Bundle - Copay Enrollment

This profile constrains a Bundle resource for use as Copay enrollment submission

Usages:

• Examples for this Profile: Bundle/7c8f5054-015b-4bce-99f5-4160a82a4225, Bundle/88b42c3d-2926-46de-b696-e8713f02f8cb and Bundle/uapi-copay-bundle-copayCRX1-PACT

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
identifier	Σ	1..1	Identifier	Persistent identifier for the bundle
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
value	Σ	0..1	string	Issuer's bundle UUID. Genentech will generate UUID if not provided. Example General: 123456
type	SΣ	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: message
Slices for entry	SΣC	7..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by type:resource, pattern:resource.ofType(Organization).type, pattern:resource.ofType(Coverage).type 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
entry:messageheader	SΣ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	S	1..1	UapiMessageHeader	A resource that describes a message that is exchanged between systems
entry:task	SΣ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	SΣ	1..1	Task	A resource in the bundle
entry:list	SΣ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	SΣ	1..1	List	A resource in the bundle
entry:patient	SΣC	1..1	BackboneElement	Patient 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	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
entry:practice	SΣ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		0..1	UapiOrganization	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	Identifier used by Genentech to determine insert vs update operation.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Unique identifier for the organization Example General: 123456
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SΣ	1..1	CodeableConcept	Organization type for enrollment Binding: UAPI Value Set - Organization Type (required): Organization Type Codes Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: prov
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name	SΣC	1..1	string	Max 255 Characters
Slices for telecom	SC	1..*	ContactPoint	A contact detail for the organization Slice: Unordered, Closed by value:system Constraints: org-3
telecom:All Slices				Content/Rules for all slices
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Phone	SC	1..*	ContactPoint	A contact detail for the organization Constraints: org-3
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Fax	SC	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
address	SC	0..*	Address	Address is required for Practice Organization and Site of Treatment Constraints: org-2
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
line	Σ	1..3	string	Max 255 Characters This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Max 30 Characters Example General: Erewhon
state	Σ	1..1	string	Standard state 2 characters (Ex: CA, AZ, NC..)
postalCode	Σ	1..1	string	Max 10 Characters Example General: 9132
contact	S	0..*	BackboneElement	Contact is required for Practice Organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		0..1	HumanName	A name associated with the contact
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required)
family	SΣ	1..1	string	Max 40 Characters
given	SΣ	1..1	string	Max 80 Characters This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom	S	1..*	ContactPoint	Required for Practice Organization Slice: Unordered, Closed by value:system
telecom:All Slices				Content/Rules for all slices
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Phone	S	1..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Fax	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Email	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: email
value	SΣ	0..1	string	Email format
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
entry:practitioner	SΣ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	S	1..1	UapiPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
entry:questionnaireresponse	SΣC	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	SΣ	1..1	QuestionnaireResponse	A resource in the bundle
entry:medicalCoverage	SΣC	0..*	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	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:PlanYear		0..1	string	UAPI Coverage Plan Year URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
extension:ReferenceNumber		0..1	string	UAPI Coverage Reference Number URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
extension:IssuedDate		0..1	date	UAPI Coverage - Card issuance date URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
type	SΣ	1..1	CodeableConcept	Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
subscriber	Σ	1..1	Reference(UAPI Patient | UAPI RelatedPerson)	Subscriber to the policy
subscriberId	SΣ	0..1	string	ID assigned to the subscriber
beneficiary	Σ	1..1	Reference(UAPI Patient)	Plan beneficiary
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient
payor	Σ	1..*	Reference(UAPI Organization)	Issuer of the policy
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Organization
class	S	1..*	BackboneElement	Additional coverage classifications
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
code	Σ	1..1	code	Symbol in syntax defined by the system
value	Σ	1..1	string	Value associated with the type
name	Σ	1..1	string	Human readable description of the type and value
order	SΣ	1..1	positiveInt	Relative order of the coverage
network	SΣ	1..1	string	Insurer network
entry:pharmacyCoverage	SΣC	0..*	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	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:PlanYear		0..1	string	UAPI Coverage Plan Year URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
extension:ReferenceNumber		0..1	string	UAPI Coverage Reference Number URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
extension:IssuedDate		0..1	date	UAPI Coverage - Card issuance date URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
type	SΣ	1..1	CodeableConcept	Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: DRUGPOL
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
subscriber	Σ	1..1	Reference(UAPI Patient | UAPI RelatedPerson)	Subscriber to the policy
subscriberId	SΣ	0..1	string	ID assigned to the subscriber
beneficiary	Σ	1..1	Reference(UAPI Patient)	Plan beneficiary
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient
payor	Σ	1..*	Reference(UAPI Organization)	Issuer of the policy
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Organization
class	S	1..*	BackboneElement	Additional coverage classifications
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
code	Σ	1..1	code	Symbol in syntax defined by the system
value	Σ	1..1	string	Value associated with the type
name	Σ	1..1	string	Human readable description of the type and value
order	SΣ	1..1	positiveInt	Relative order of the coverage
network	SΣ	1..1	string	Insurer network
entry:payer	SΣC	0..*	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	S	0..1	UapiOrganization	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	Identifier used by Genentech to determine insert vs update operation.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Unique identifier for the organization Example General: 123456
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SΣ	1..1	CodeableConcept	Organization type for enrollment Binding: UAPI Value Set - Organization Type (required): Organization Type Codes Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ins
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name	SΣC	1..1	string	Max 255 Characters
Slices for telecom	SC	1..*	ContactPoint	A contact detail for the organization Slice: Unordered, Closed by value:system Constraints: org-3
telecom:All Slices				Content/Rules for all slices
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Phone	SC	1..*	ContactPoint	A contact detail for the organization Constraints: org-3
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Fax	SC	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
address	SC	0..*	Address	Address is required for Practice Organization and Site of Treatment Constraints: org-2
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
line	Σ	1..3	string	Max 255 Characters This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Max 30 Characters Example General: Erewhon
state	Σ	1..1	string	Standard state 2 characters (Ex: CA, AZ, NC..)
postalCode	Σ	1..1	string	Max 10 Characters Example General: 9132
contact	S	0..*	BackboneElement	Contact is required for Practice Organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		0..1	HumanName	A name associated with the contact
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required)
family	SΣ	1..1	string	Max 40 Characters
given	SΣ	1..1	string	Max 80 Characters This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom	S	1..*	ContactPoint	Required for Practice Organization Slice: Unordered, Closed by value:system
telecom:All Slices				Content/Rules for all slices
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Phone	S	1..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Fax	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Email	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: email
value	SΣ	0..1	string	Email format
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.type	required	Fixed Value: message http://hl7.org/fhir/ValueSet/bundle-type|4.3.0 From the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:messageheader.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:task.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:list.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:patient.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.type	required	Pattern Value: prov https://fhir.developer.gene.com/ValueSet/uapi-org-type From this IG
Bundle.entry:practice.resource.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practitioner.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:questionnaireresponse.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:medicalCoverage.resource.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.3.0 From the FHIR Standard
Bundle.entry:medicalCoverage.resource.type	preferred	Pattern Value: HIP http://hl7.org/fhir/ValueSet/coverage-type From the FHIR Standard
Bundle.entry:medicalCoverage.resource.beneficiary.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:medicalCoverage.resource.payor.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:medicalCoverage.resource.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class From the FHIR Standard
Bundle.entry:medicalCoverage.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.3.0 From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.type	preferred	Pattern Value: DRUGPOL http://hl7.org/fhir/ValueSet/coverage-type From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.beneficiary.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.payor.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class From the FHIR Standard
Bundle.entry:pharmacyCoverage.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.type	required	Pattern Value: ins https://fhir.developer.gene.com/ValueSet/uapi-org-type From this IG
Bundle.entry:payer.resource.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.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-5	error	Bundle.entry, Bundle.entry:messageheader, Bundle.entry:task, Bundle.entry:list, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:practitioner, Bundle.entry:questionnaireresponse, Bundle.entry:medicalCoverage, Bundle.entry:pharmacyCoverage, Bundle.entry:payer	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl 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-8	error	Bundle.entry, Bundle.entry:messageheader, Bundle.entry:task, Bundle.entry:list, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:practitioner, Bundle.entry:questionnaireresponse, Bundle.entry:medicalCoverage, Bundle.entry:pharmacyCoverage, Bundle.entry:payer	fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-2	error	Bundle.entry:practice.resource.address, Bundle.entry:payer.resource.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Bundle.entry:practice.resource.telecom, Bundle.entry:practice.resource.telecom:Phone, Bundle.entry:practice.resource.telecom:Fax, Bundle.entry:payer.resource.telecom, Bundle.entry:payer.resource.telecom:Phone, Bundle.entry:payer.resource.telecom:Fax	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle		0..*	Bundle	Contains a collection of resources
identifier		1..1	Identifier	Persistent identifier for the bundle
type
coding
system		1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Required Pattern: RI
value		0..1	string	Issuer's bundle UUID. Genentech will generate UUID if not provided.
type	S	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: message
total		0..0
Slices for entry	S	7..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by type:resource, pattern:resource.ofType(Organization).type, pattern:resource.ofType(Coverage).type
entry:All Slices				Content/Rules for all slices
search		0..0
request		0..0
response		0..0
entry:messageheader	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	UapiMessageHeader	A resource that describes a message that is exchanged between systems
entry:task	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	Task	A resource in the bundle
entry:list	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	List	A resource in the bundle
entry:patient	S	1..1	BackboneElement	Patient
resource	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
entry:practice	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource		0..1	UapiOrganization	A grouping of people or organizations with a common purpose
type		1..1	CodeableConcept	Organization type for enrollment Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: prov
entry:practitioner	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	UapiPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
entry:questionnaireresponse	S	1..*	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	QuestionnaireResponse	A resource in the bundle
entry:medicalCoverage	S	0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
type		1..1	CodeableConcept	Coverage category such as medical or accident Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIP
entry:pharmacyCoverage	S	0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
type		1..1	CodeableConcept	Coverage category such as medical or accident Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code		1..1	code	Symbol in syntax defined by the system Fixed Value: DRUGPOL
entry:payer	S	0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	0..1	UapiOrganization	A grouping of people or organizations with a common purpose
type		1..1	CodeableConcept	Organization type for enrollment Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ins
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
identifier	Σ	1..1	Identifier	Persistent identifier for the bundle
id		0..1	id	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)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Required Pattern: RI
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	Issuer's bundle UUID. Genentech will generate UUID if not provided. 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)
type	SΣ	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: message
timestamp	Σ	0..1	instant	When the bundle was assembled
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	7..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by type:resource, pattern:resource.ofType(Organization).type, pattern:resource.ofType(Coverage).type 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	Σ	0..1	Resource	A resource in the bundle
entry:messageheader	SΣ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	S	1..1	UapiMessageHeader	A resource that describes a message that is exchanged between systems
entry:task	SΣ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	SΣ	1..1	Task	A resource in the bundle
entry:list	SΣ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	SΣ	1..1	List	A resource in the bundle
entry:patient	SΣC	1..1	BackboneElement	Patient 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	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
entry:practice	SΣ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		0..1	UapiOrganization	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): IETF language tag Additional Bindings Purpose 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 Constraints: dom-r4b
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣC	1..*	Identifier	Identifier used by Genentech to determine insert vs update operation.
id		0..1	id	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)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Unique identifier for the organization 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 the organization's record is still in active use
type	SΣ	1..1	CodeableConcept	Organization type for enrollment Binding: UAPI Value Set - Organization Type (required): Organization Type Codes Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: prov
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name	SΣC	1..1	string	Max 255 Characters
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Slices for telecom	SC	1..*	ContactPoint	A contact detail for the organization Slice: Unordered, Closed by value:system Constraints: org-3
telecom:All Slices				Content/Rules for all slices
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Phone	SC	1..*	ContactPoint	A contact detail for the organization Constraints: org-3
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Fax	SC	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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	0..*	Address	Address is required for Practice Organization and Site of Treatment Constraints: org-2
id		0..1	id	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 (home / work / etc.). 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..3	string	Max 255 Characters This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Max 30 Characters Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	1..1	string	Standard state 2 characters (Ex: CA, AZ, NC..)
postalCode	Σ	1..1	string	Max 10 Characters 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"}
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact	S	0..*	BackboneElement	Contact is required for Practice Organization
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
id		0..1	id	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)
text	Σ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Max 40 Characters
given	SΣ	1..1	string	Max 80 Characters 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
Slices for telecom	S	1..*	ContactPoint	Required for Practice Organization Slice: Unordered, Closed by value:system
telecom:All Slices				Content/Rules for all slices
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Phone	S	1..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Fax	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Email	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: email
value	SΣ	0..1	string	Email format
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
entry:practitioner	SΣ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	S	1..1	UapiPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
entry:questionnaireresponse	SΣC	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	SΣ	1..1	QuestionnaireResponse	A resource in the bundle
entry:medicalCoverage	SΣC	0..*	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	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
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): IETF language tag Additional Bindings Purpose 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 Constraints: dom-r4b
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:PlanYear		0..1	string	UAPI Coverage Plan Year URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
extension:ReferenceNumber		0..1	string	UAPI Coverage Reference Number URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
extension:IssuedDate		0..1	date	UAPI Coverage - Card issuance date URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business Identifier for the coverage
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
type	SΣ	1..1	CodeableConcept	Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
policyHolder	Σ	0..1	Reference(Patient | RelatedPerson | Organization)	Owner of the policy
subscriber	Σ	1..1	Reference(UAPI Patient | UAPI RelatedPerson)	Subscriber to the policy
id		0..1	id	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	Patient or RelatedPerson resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible)
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
subscriberId	SΣ	0..1	string	ID assigned to the subscriber
beneficiary	Σ	1..1	Reference(UAPI Patient)	Plan beneficiary
id		0..1	id	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	Patient resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
dependent	Σ	0..1	string	Dependent number
relationship		0..1	CodeableConcept	Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
period	Σ	0..1	Period	Coverage start and end dates
payor	Σ	1..*	Reference(UAPI Organization)	Issuer of the policy
id		0..1	id	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	Payor Orginization resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Organization
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
class	S	1..*	BackboneElement	Additional coverage classifications
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
type	Σ	1..1	CodeableConcept	Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
value	Σ	1..1	string	Value associated with the type
name	Σ	1..1	string	Human readable description of the type and value
order	SΣ	1..1	positiveInt	Relative order of the coverage
network	SΣ	1..1	string	Insurer network
costToBeneficiary		0..*	BackboneElement	Patient payments for services/products
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
type	Σ	0..1	CodeableConcept	Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.
value[x]	Σ	1..1		The amount or percentage due from the beneficiary
valueQuantity			Quantity(SimpleQuantity)
valueMoney			Money
exception		0..*	BackboneElement	Exceptions for patient payments
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
type	Σ	1..1	CodeableConcept	Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.
period	Σ	0..1	Period	The effective period of the exception
subrogation		0..1	boolean	Reimbursement to insurer
contract		0..*	Reference(Contract)	Contract details
entry:pharmacyCoverage	SΣC	0..*	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	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
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): IETF language tag Additional Bindings Purpose 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 Constraints: dom-r4b
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:PlanYear		0..1	string	UAPI Coverage Plan Year URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
extension:ReferenceNumber		0..1	string	UAPI Coverage Reference Number URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
extension:IssuedDate		0..1	date	UAPI Coverage - Card issuance date URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business Identifier for the coverage
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
type	SΣ	1..1	CodeableConcept	Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: DRUGPOL
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
policyHolder	Σ	0..1	Reference(Patient | RelatedPerson | Organization)	Owner of the policy
subscriber	Σ	1..1	Reference(UAPI Patient | UAPI RelatedPerson)	Subscriber to the policy
id		0..1	id	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	Patient or RelatedPerson resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible)
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
subscriberId	SΣ	0..1	string	ID assigned to the subscriber
beneficiary	Σ	1..1	Reference(UAPI Patient)	Plan beneficiary
id		0..1	id	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	Patient resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
dependent	Σ	0..1	string	Dependent number
relationship		0..1	CodeableConcept	Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
period	Σ	0..1	Period	Coverage start and end dates
payor	Σ	1..*	Reference(UAPI Organization)	Issuer of the policy
id		0..1	id	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	Payor Orginization resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Organization
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
class	S	1..*	BackboneElement	Additional coverage classifications
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
type	Σ	1..1	CodeableConcept	Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
value	Σ	1..1	string	Value associated with the type
name	Σ	1..1	string	Human readable description of the type and value
order	SΣ	1..1	positiveInt	Relative order of the coverage
network	SΣ	1..1	string	Insurer network
costToBeneficiary		0..*	BackboneElement	Patient payments for services/products
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
type	Σ	0..1	CodeableConcept	Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.
value[x]	Σ	1..1		The amount or percentage due from the beneficiary
valueQuantity			Quantity(SimpleQuantity)
valueMoney			Money
exception		0..*	BackboneElement	Exceptions for patient payments
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
type	Σ	1..1	CodeableConcept	Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.
period	Σ	0..1	Period	The effective period of the exception
subrogation		0..1	boolean	Reimbursement to insurer
contract		0..*	Reference(Contract)	Contract details
entry:payer	SΣC	0..*	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	S	0..1	UapiOrganization	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): IETF language tag Additional Bindings Purpose 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 Constraints: dom-r4b
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣC	1..*	Identifier	Identifier used by Genentech to determine insert vs update operation.
id		0..1	id	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)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Unique identifier for the organization 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 the organization's record is still in active use
type	SΣ	1..1	CodeableConcept	Organization type for enrollment Binding: UAPI Value Set - Organization Type (required): Organization Type Codes Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ins
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name	SΣC	1..1	string	Max 255 Characters
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Slices for telecom	SC	1..*	ContactPoint	A contact detail for the organization Slice: Unordered, Closed by value:system Constraints: org-3
telecom:All Slices				Content/Rules for all slices
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Phone	SC	1..*	ContactPoint	A contact detail for the organization Constraints: org-3
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Fax	SC	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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	0..*	Address	Address is required for Practice Organization and Site of Treatment Constraints: org-2
id		0..1	id	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 (home / work / etc.). 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..3	string	Max 255 Characters This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Max 30 Characters Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	1..1	string	Standard state 2 characters (Ex: CA, AZ, NC..)
postalCode	Σ	1..1	string	Max 10 Characters 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"}
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact	S	0..*	BackboneElement	Contact is required for Practice Organization
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
id		0..1	id	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)
text	Σ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Max 40 Characters
given	SΣ	1..1	string	Max 80 Characters 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
Slices for telecom	S	1..*	ContactPoint	Required for Practice Organization Slice: Unordered, Closed by value:system
telecom:All Slices				Content/Rules for all slices
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Phone	S	1..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Fax	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Email	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: email
value	SΣ	0..1	string	Email format
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Bundle.type	required	Fixed Value: message http://hl7.org/fhir/ValueSet/bundle-type|4.3.0 From the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:messageheader.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:messageheader.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:task.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:task.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:list.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:list.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:patient.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:patient.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.entry:practice.resource.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Bundle.entry:practice.resource.type	required	Pattern Value: prov https://fhir.developer.gene.com/ValueSet/uapi-org-type From this IG
Bundle.entry:practice.resource.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type From the FHIR Standard
Bundle.entry:practice.resource.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:practice.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practitioner.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:practitioner.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:questionnaireresponse.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:questionnaireresponse.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:medicalCoverage.resource.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.entry:medicalCoverage.resource.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.3.0 From the FHIR Standard
Bundle.entry:medicalCoverage.resource.type	preferred	Pattern Value: HIP http://hl7.org/fhir/ValueSet/coverage-type From the FHIR Standard
Bundle.entry:medicalCoverage.resource.subscriber.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:medicalCoverage.resource.beneficiary.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:medicalCoverage.resource.relationship	extensible	SubscriberRelationshipCodes http://hl7.org/fhir/ValueSet/subscriber-relationship From the FHIR Standard
Bundle.entry:medicalCoverage.resource.payor.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:medicalCoverage.resource.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class From the FHIR Standard
Bundle.entry:medicalCoverage.resource.costToBeneficiary.type	extensible	CoverageCopayTypeCodes http://hl7.org/fhir/ValueSet/coverage-copay-type From the FHIR Standard
Bundle.entry:medicalCoverage.resource.costToBeneficiary.exception.type	example	ExampleCoverageFinancialExceptionCodes http://hl7.org/fhir/ValueSet/coverage-financial-exception From the FHIR Standard
Bundle.entry:medicalCoverage.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:medicalCoverage.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.entry:pharmacyCoverage.resource.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.3.0 From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.type	preferred	Pattern Value: DRUGPOL http://hl7.org/fhir/ValueSet/coverage-type From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.subscriber.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.beneficiary.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.relationship	extensible	SubscriberRelationshipCodes http://hl7.org/fhir/ValueSet/subscriber-relationship From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.payor.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.type	extensible	CoverageCopayTypeCodes http://hl7.org/fhir/ValueSet/coverage-copay-type From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.exception.type	example	ExampleCoverageFinancialExceptionCodes http://hl7.org/fhir/ValueSet/coverage-financial-exception From the FHIR Standard
Bundle.entry:pharmacyCoverage.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:pharmacyCoverage.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.entry:payer.resource.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Bundle.entry:payer.resource.type	required	Pattern Value: ins https://fhir.developer.gene.com/ValueSet/uapi-org-type From this IG
Bundle.entry:payer.resource.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type From the FHIR Standard
Bundle.entry:payer.resource.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:payer.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.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-5	error	Bundle.entry, Bundle.entry:messageheader, Bundle.entry:task, Bundle.entry:list, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:practitioner, Bundle.entry:questionnaireresponse, Bundle.entry:medicalCoverage, Bundle.entry:pharmacyCoverage, Bundle.entry:payer	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl 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-8	error	Bundle.entry, Bundle.entry:messageheader, Bundle.entry:task, Bundle.entry:list, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:practitioner, Bundle.entry:questionnaireresponse, Bundle.entry:medicalCoverage, Bundle.entry:pharmacyCoverage, Bundle.entry:payer	fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
dom-r4b	warning	Bundle.entry:practice.resource.contained, Bundle.entry:medicalCoverage.resource.contained, Bundle.entry:pharmacyCoverage.resource.contained, Bundle.entry:payer.resource.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-2	error	Bundle.entry:practice.resource.address, Bundle.entry:payer.resource.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Bundle.entry:practice.resource.telecom, Bundle.entry:practice.resource.telecom:Phone, Bundle.entry:practice.resource.telecom:Fax, Bundle.entry:payer.resource.telecom, Bundle.entry:payer.resource.telecom:Phone, Bundle.entry:payer.resource.telecom:Fax	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

This structure is derived from Bundle

Summary

Mandatory: 14 elements(2 nested mandatory elements)
Must-Support: 21 elements
Fixed: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

• UAPI MessageHeader (https://fhir.developer.gene.com/StructureDefinition/uapi-messageheader)
• UAPI Patient (https://fhir.developer.gene.com/StructureDefinition/uapi-patient)
• UAPI Organization (https://fhir.developer.gene.com/StructureDefinition/uapi-organization)
• UAPI Practitioner (https://fhir.developer.gene.com/StructureDefinition/uapi-practitioner)
• UAPI Coverage (https://fhir.developer.gene.com/StructureDefinition/uapi-coverage)

Slices

This structure defines the following Slices:

• The element 3 is sliced based on the values of Bundle.entry (Closed)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
identifier	Σ	1..1	Identifier	Persistent identifier for the bundle
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
value	Σ	0..1	string	Issuer's bundle UUID. Genentech will generate UUID if not provided. Example General: 123456
type	SΣ	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: message
Slices for entry	SΣC	7..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by type:resource, pattern:resource.ofType(Organization).type, pattern:resource.ofType(Coverage).type 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
entry:messageheader	SΣ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	S	1..1	UapiMessageHeader	A resource that describes a message that is exchanged between systems
entry:task	SΣ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	SΣ	1..1	Task	A resource in the bundle
entry:list	SΣ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	SΣ	1..1	List	A resource in the bundle
entry:patient	SΣC	1..1	BackboneElement	Patient 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	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
entry:practice	SΣ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		0..1	UapiOrganization	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	Identifier used by Genentech to determine insert vs update operation.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Unique identifier for the organization Example General: 123456
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SΣ	1..1	CodeableConcept	Organization type for enrollment Binding: UAPI Value Set - Organization Type (required): Organization Type Codes Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: prov
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name	SΣC	1..1	string	Max 255 Characters
Slices for telecom	SC	1..*	ContactPoint	A contact detail for the organization Slice: Unordered, Closed by value:system Constraints: org-3
telecom:All Slices				Content/Rules for all slices
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Phone	SC	1..*	ContactPoint	A contact detail for the organization Constraints: org-3
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Fax	SC	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
address	SC	0..*	Address	Address is required for Practice Organization and Site of Treatment Constraints: org-2
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
line	Σ	1..3	string	Max 255 Characters This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Max 30 Characters Example General: Erewhon
state	Σ	1..1	string	Standard state 2 characters (Ex: CA, AZ, NC..)
postalCode	Σ	1..1	string	Max 10 Characters Example General: 9132
contact	S	0..*	BackboneElement	Contact is required for Practice Organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		0..1	HumanName	A name associated with the contact
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required)
family	SΣ	1..1	string	Max 40 Characters
given	SΣ	1..1	string	Max 80 Characters This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom	S	1..*	ContactPoint	Required for Practice Organization Slice: Unordered, Closed by value:system
telecom:All Slices				Content/Rules for all slices
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Phone	S	1..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Fax	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Email	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: email
value	SΣ	0..1	string	Email format
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
entry:practitioner	SΣ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	S	1..1	UapiPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
entry:questionnaireresponse	SΣC	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	SΣ	1..1	QuestionnaireResponse	A resource in the bundle
entry:medicalCoverage	SΣC	0..*	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	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:PlanYear		0..1	string	UAPI Coverage Plan Year URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
extension:ReferenceNumber		0..1	string	UAPI Coverage Reference Number URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
extension:IssuedDate		0..1	date	UAPI Coverage - Card issuance date URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
type	SΣ	1..1	CodeableConcept	Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
subscriber	Σ	1..1	Reference(UAPI Patient | UAPI RelatedPerson)	Subscriber to the policy
subscriberId	SΣ	0..1	string	ID assigned to the subscriber
beneficiary	Σ	1..1	Reference(UAPI Patient)	Plan beneficiary
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient
payor	Σ	1..*	Reference(UAPI Organization)	Issuer of the policy
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Organization
class	S	1..*	BackboneElement	Additional coverage classifications
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
code	Σ	1..1	code	Symbol in syntax defined by the system
value	Σ	1..1	string	Value associated with the type
name	Σ	1..1	string	Human readable description of the type and value
order	SΣ	1..1	positiveInt	Relative order of the coverage
network	SΣ	1..1	string	Insurer network
entry:pharmacyCoverage	SΣC	0..*	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	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:PlanYear		0..1	string	UAPI Coverage Plan Year URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
extension:ReferenceNumber		0..1	string	UAPI Coverage Reference Number URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
extension:IssuedDate		0..1	date	UAPI Coverage - Card issuance date URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
type	SΣ	1..1	CodeableConcept	Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: DRUGPOL
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
subscriber	Σ	1..1	Reference(UAPI Patient | UAPI RelatedPerson)	Subscriber to the policy
subscriberId	SΣ	0..1	string	ID assigned to the subscriber
beneficiary	Σ	1..1	Reference(UAPI Patient)	Plan beneficiary
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient
payor	Σ	1..*	Reference(UAPI Organization)	Issuer of the policy
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Organization
class	S	1..*	BackboneElement	Additional coverage classifications
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	CodeableConcept	Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
code	Σ	1..1	code	Symbol in syntax defined by the system
value	Σ	1..1	string	Value associated with the type
name	Σ	1..1	string	Human readable description of the type and value
order	SΣ	1..1	positiveInt	Relative order of the coverage
network	SΣ	1..1	string	Insurer network
entry:payer	SΣC	0..*	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	S	0..1	UapiOrganization	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	Identifier used by Genentech to determine insert vs update operation.
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Unique identifier for the organization Example General: 123456
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	SΣ	1..1	CodeableConcept	Organization type for enrollment Binding: UAPI Value Set - Organization Type (required): Organization Type Codes Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ins
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name	SΣC	1..1	string	Max 255 Characters
Slices for telecom	SC	1..*	ContactPoint	A contact detail for the organization Slice: Unordered, Closed by value:system Constraints: org-3
telecom:All Slices				Content/Rules for all slices
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Phone	SC	1..*	ContactPoint	A contact detail for the organization Constraints: org-3
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Fax	SC	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
address	SC	0..*	Address	Address is required for Practice Organization and Site of Treatment Constraints: org-2
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
line	Σ	1..3	string	Max 255 Characters This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Max 30 Characters Example General: Erewhon
state	Σ	1..1	string	Standard state 2 characters (Ex: CA, AZ, NC..)
postalCode	Σ	1..1	string	Max 10 Characters Example General: 9132
contact	S	0..*	BackboneElement	Contact is required for Practice Organization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		0..1	HumanName	A name associated with the contact
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required)
family	SΣ	1..1	string	Max 40 Characters
given	SΣ	1..1	string	Max 80 Characters This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom	S	1..*	ContactPoint	Required for Practice Organization Slice: Unordered, Closed by value:system
telecom:All Slices				Content/Rules for all slices
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Phone	S	1..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Fax	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
telecom:Email	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: email
value	SΣ	0..1	string	Email format
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.type	required	Fixed Value: message http://hl7.org/fhir/ValueSet/bundle-type|4.3.0 From the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:messageheader.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:task.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:list.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:patient.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.type	required	Pattern Value: prov https://fhir.developer.gene.com/ValueSet/uapi-org-type From this IG
Bundle.entry:practice.resource.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practitioner.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:questionnaireresponse.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:medicalCoverage.resource.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.3.0 From the FHIR Standard
Bundle.entry:medicalCoverage.resource.type	preferred	Pattern Value: HIP http://hl7.org/fhir/ValueSet/coverage-type From the FHIR Standard
Bundle.entry:medicalCoverage.resource.beneficiary.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:medicalCoverage.resource.payor.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:medicalCoverage.resource.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class From the FHIR Standard
Bundle.entry:medicalCoverage.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.3.0 From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.type	preferred	Pattern Value: DRUGPOL http://hl7.org/fhir/ValueSet/coverage-type From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.beneficiary.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.payor.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class From the FHIR Standard
Bundle.entry:pharmacyCoverage.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.type	required	Pattern Value: ins https://fhir.developer.gene.com/ValueSet/uapi-org-type From this IG
Bundle.entry:payer.resource.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.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-5	error	Bundle.entry, Bundle.entry:messageheader, Bundle.entry:task, Bundle.entry:list, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:practitioner, Bundle.entry:questionnaireresponse, Bundle.entry:medicalCoverage, Bundle.entry:pharmacyCoverage, Bundle.entry:payer	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl 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-8	error	Bundle.entry, Bundle.entry:messageheader, Bundle.entry:task, Bundle.entry:list, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:practitioner, Bundle.entry:questionnaireresponse, Bundle.entry:medicalCoverage, Bundle.entry:pharmacyCoverage, Bundle.entry:payer	fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-2	error	Bundle.entry:practice.resource.address, Bundle.entry:payer.resource.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Bundle.entry:practice.resource.telecom, Bundle.entry:practice.resource.telecom:Phone, Bundle.entry:practice.resource.telecom:Fax, Bundle.entry:payer.resource.telecom, Bundle.entry:payer.resource.telecom:Phone, Bundle.entry:payer.resource.telecom:Fax	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

Differential View

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle		0..*	Bundle	Contains a collection of resources
identifier		1..1	Identifier	Persistent identifier for the bundle
type
coding
system		1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Required Pattern: RI
value		0..1	string	Issuer's bundle UUID. Genentech will generate UUID if not provided.
type	S	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: message
total		0..0
Slices for entry	S	7..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by type:resource, pattern:resource.ofType(Organization).type, pattern:resource.ofType(Coverage).type
entry:All Slices				Content/Rules for all slices
search		0..0
request		0..0
response		0..0
entry:messageheader	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	UapiMessageHeader	A resource that describes a message that is exchanged between systems
entry:task	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	Task	A resource in the bundle
entry:list	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	List	A resource in the bundle
entry:patient	S	1..1	BackboneElement	Patient
resource	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
entry:practice	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource		0..1	UapiOrganization	A grouping of people or organizations with a common purpose
type		1..1	CodeableConcept	Organization type for enrollment Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: prov
entry:practitioner	S	1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	UapiPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
entry:questionnaireresponse	S	1..*	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	1..1	QuestionnaireResponse	A resource in the bundle
entry:medicalCoverage	S	0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
type		1..1	CodeableConcept	Coverage category such as medical or accident Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIP
entry:pharmacyCoverage	S	0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
type		1..1	CodeableConcept	Coverage category such as medical or accident Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code		1..1	code	Symbol in syntax defined by the system Fixed Value: DRUGPOL
entry:payer	S	0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource	S	0..1	UapiOrganization	A grouping of people or organizations with a common purpose
type		1..1	CodeableConcept	Organization type for enrollment Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ins
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
identifier	Σ	1..1	Identifier	Persistent identifier for the bundle
id		0..1	id	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)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Required Pattern: RI
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	Issuer's bundle UUID. Genentech will generate UUID if not provided. 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)
type	SΣ	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: message
timestamp	Σ	0..1	instant	When the bundle was assembled
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	7..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by type:resource, pattern:resource.ofType(Organization).type, pattern:resource.ofType(Coverage).type 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	Σ	0..1	Resource	A resource in the bundle
entry:messageheader	SΣ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	S	1..1	UapiMessageHeader	A resource that describes a message that is exchanged between systems
entry:task	SΣ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	SΣ	1..1	Task	A resource in the bundle
entry:list	SΣ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	SΣ	1..1	List	A resource in the bundle
entry:patient	SΣC	1..1	BackboneElement	Patient 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	S	1..1	UapiPatient	Information about an individual or animal receiving health care services
entry:practice	SΣ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		0..1	UapiOrganization	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): IETF language tag Additional Bindings Purpose 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 Constraints: dom-r4b
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣC	1..*	Identifier	Identifier used by Genentech to determine insert vs update operation.
id		0..1	id	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)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Unique identifier for the organization 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 the organization's record is still in active use
type	SΣ	1..1	CodeableConcept	Organization type for enrollment Binding: UAPI Value Set - Organization Type (required): Organization Type Codes Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: prov
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name	SΣC	1..1	string	Max 255 Characters
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Slices for telecom	SC	1..*	ContactPoint	A contact detail for the organization Slice: Unordered, Closed by value:system Constraints: org-3
telecom:All Slices				Content/Rules for all slices
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Phone	SC	1..*	ContactPoint	A contact detail for the organization Constraints: org-3
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Fax	SC	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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	0..*	Address	Address is required for Practice Organization and Site of Treatment Constraints: org-2
id		0..1	id	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 (home / work / etc.). 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..3	string	Max 255 Characters This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Max 30 Characters Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	1..1	string	Standard state 2 characters (Ex: CA, AZ, NC..)
postalCode	Σ	1..1	string	Max 10 Characters 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"}
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact	S	0..*	BackboneElement	Contact is required for Practice Organization
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
id		0..1	id	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)
text	Σ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Max 40 Characters
given	SΣ	1..1	string	Max 80 Characters 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
Slices for telecom	S	1..*	ContactPoint	Required for Practice Organization Slice: Unordered, Closed by value:system
telecom:All Slices				Content/Rules for all slices
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Phone	S	1..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Fax	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Email	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: email
value	SΣ	0..1	string	Email format
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
entry:practitioner	SΣ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	S	1..1	UapiPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
entry:questionnaireresponse	SΣC	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	SΣ	1..1	QuestionnaireResponse	A resource in the bundle
entry:medicalCoverage	SΣC	0..*	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	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
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): IETF language tag Additional Bindings Purpose 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 Constraints: dom-r4b
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:PlanYear		0..1	string	UAPI Coverage Plan Year URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
extension:ReferenceNumber		0..1	string	UAPI Coverage Reference Number URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
extension:IssuedDate		0..1	date	UAPI Coverage - Card issuance date URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business Identifier for the coverage
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
type	SΣ	1..1	CodeableConcept	Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: HIP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
policyHolder	Σ	0..1	Reference(Patient | RelatedPerson | Organization)	Owner of the policy
subscriber	Σ	1..1	Reference(UAPI Patient | UAPI RelatedPerson)	Subscriber to the policy
id		0..1	id	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	Patient or RelatedPerson resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible)
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
subscriberId	SΣ	0..1	string	ID assigned to the subscriber
beneficiary	Σ	1..1	Reference(UAPI Patient)	Plan beneficiary
id		0..1	id	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	Patient resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
dependent	Σ	0..1	string	Dependent number
relationship		0..1	CodeableConcept	Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
period	Σ	0..1	Period	Coverage start and end dates
payor	Σ	1..*	Reference(UAPI Organization)	Issuer of the policy
id		0..1	id	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	Payor Orginization resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Organization
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
class	S	1..*	BackboneElement	Additional coverage classifications
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
type	Σ	1..1	CodeableConcept	Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
value	Σ	1..1	string	Value associated with the type
name	Σ	1..1	string	Human readable description of the type and value
order	SΣ	1..1	positiveInt	Relative order of the coverage
network	SΣ	1..1	string	Insurer network
costToBeneficiary		0..*	BackboneElement	Patient payments for services/products
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
type	Σ	0..1	CodeableConcept	Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.
value[x]	Σ	1..1		The amount or percentage due from the beneficiary
valueQuantity			Quantity(SimpleQuantity)
valueMoney			Money
exception		0..*	BackboneElement	Exceptions for patient payments
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
type	Σ	1..1	CodeableConcept	Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.
period	Σ	0..1	Period	The effective period of the exception
subrogation		0..1	boolean	Reimbursement to insurer
contract		0..*	Reference(Contract)	Contract details
entry:pharmacyCoverage	SΣC	0..*	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	S	0..1	UapiCoverage	Insurance or medical plan or a payment agreement
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): IETF language tag Additional Bindings Purpose 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 Constraints: dom-r4b
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:PlanYear		0..1	string	UAPI Coverage Plan Year URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
extension:ReferenceNumber		0..1	string	UAPI Coverage Reference Number URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
extension:IssuedDate		0..1	date	UAPI Coverage - Card issuance date URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business Identifier for the coverage
status	?!Σ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
type	SΣ	1..1	CodeableConcept	Coverage category such as medical or accident Binding: CoverageTypeAndSelf-PayCodes (preferred): The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: DRUGPOL
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
policyHolder	Σ	0..1	Reference(Patient | RelatedPerson | Organization)	Owner of the policy
subscriber	Σ	1..1	Reference(UAPI Patient | UAPI RelatedPerson)	Subscriber to the policy
id		0..1	id	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	Patient or RelatedPerson resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible)
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
subscriberId	SΣ	0..1	string	ID assigned to the subscriber
beneficiary	Σ	1..1	Reference(UAPI Patient)	Plan beneficiary
id		0..1	id	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	Patient resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Patient
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
dependent	Σ	0..1	string	Dependent number
relationship		0..1	CodeableConcept	Beneficiary relationship to the subscriber Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).
period	Σ	0..1	Period	Coverage start and end dates
payor	Σ	1..*	Reference(UAPI Organization)	Issuer of the policy
id		0..1	id	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	Payor Orginization resource UUID
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) Required Pattern: Organization
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
class	S	1..*	BackboneElement	Additional coverage classifications
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
type	Σ	1..1	CodeableConcept	Type of class such as 'group' or 'plan' Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
value	Σ	1..1	string	Value associated with the type
name	Σ	1..1	string	Human readable description of the type and value
order	SΣ	1..1	positiveInt	Relative order of the coverage
network	SΣ	1..1	string	Insurer network
costToBeneficiary		0..*	BackboneElement	Patient payments for services/products
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
type	Σ	0..1	CodeableConcept	Cost category Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.
value[x]	Σ	1..1		The amount or percentage due from the beneficiary
valueQuantity			Quantity(SimpleQuantity)
valueMoney			Money
exception		0..*	BackboneElement	Exceptions for patient payments
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
type	Σ	1..1	CodeableConcept	Exception category Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.
period	Σ	0..1	Period	The effective period of the exception
subrogation		0..1	boolean	Reimbursement to insurer
contract		0..*	Reference(Contract)	Contract details
entry:payer	SΣC	0..*	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	S	0..1	UapiOrganization	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): IETF language tag Additional Bindings Purpose 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 Constraints: dom-r4b
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣC	1..*	Identifier	Identifier used by Genentech to determine insert vs update operation.
id		0..1	id	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)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Unique identifier for the organization 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 the organization's record is still in active use
type	SΣ	1..1	CodeableConcept	Organization type for enrollment Binding: UAPI Value Set - Organization Type (required): Organization Type Codes Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ins
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
name	SΣC	1..1	string	Max 255 Characters
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Slices for telecom	SC	1..*	ContactPoint	A contact detail for the organization Slice: Unordered, Closed by value:system Constraints: org-3
telecom:All Slices				Content/Rules for all slices
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Phone	SC	1..*	ContactPoint	A contact detail for the organization Constraints: org-3
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Fax	SC	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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	0..*	Address	Address is required for Practice Organization and Site of Treatment Constraints: org-2
id		0..1	id	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 (home / work / etc.). 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..3	string	Max 255 Characters This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	1..1	string	Max 30 Characters Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	1..1	string	Standard state 2 characters (Ex: CA, AZ, NC..)
postalCode	Σ	1..1	string	Max 10 Characters 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"}
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact	S	0..*	BackboneElement	Contact is required for Practice Organization
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
id		0..1	id	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)
text	Σ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Max 40 Characters
given	SΣ	1..1	string	Max 80 Characters 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
Slices for telecom	S	1..*	ContactPoint	Required for Practice Organization Slice: Unordered, Closed by value:system
telecom:All Slices				Content/Rules for all slices
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required)
value	SΣ	0..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Phone	S	1..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone
value	SΣ	0..1	string	Phone (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Fax	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: fax
value	SΣ	0..1	string	Fax (10 digit numeric values only)
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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
telecom:Email	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: email
value	SΣ	0..1	string	Email format
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
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..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
signature	Σ	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Bundle.type	required	Fixed Value: message http://hl7.org/fhir/ValueSet/bundle-type|4.3.0 From the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:messageheader.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:messageheader.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:task.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:task.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:list.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:list.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:patient.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:patient.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.entry:practice.resource.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Bundle.entry:practice.resource.type	required	Pattern Value: prov https://fhir.developer.gene.com/ValueSet/uapi-org-type From this IG
Bundle.entry:practice.resource.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type From the FHIR Standard
Bundle.entry:practice.resource.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:practice.resource.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:practice.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:practice.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:practitioner.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:practitioner.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:questionnaireresponse.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:questionnaireresponse.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:medicalCoverage.resource.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.entry:medicalCoverage.resource.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.3.0 From the FHIR Standard
Bundle.entry:medicalCoverage.resource.type	preferred	Pattern Value: HIP http://hl7.org/fhir/ValueSet/coverage-type From the FHIR Standard
Bundle.entry:medicalCoverage.resource.subscriber.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:medicalCoverage.resource.beneficiary.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:medicalCoverage.resource.relationship	extensible	SubscriberRelationshipCodes http://hl7.org/fhir/ValueSet/subscriber-relationship From the FHIR Standard
Bundle.entry:medicalCoverage.resource.payor.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:medicalCoverage.resource.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class From the FHIR Standard
Bundle.entry:medicalCoverage.resource.costToBeneficiary.type	extensible	CoverageCopayTypeCodes http://hl7.org/fhir/ValueSet/coverage-copay-type From the FHIR Standard
Bundle.entry:medicalCoverage.resource.costToBeneficiary.exception.type	example	ExampleCoverageFinancialExceptionCodes http://hl7.org/fhir/ValueSet/coverage-financial-exception From the FHIR Standard
Bundle.entry:medicalCoverage.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:medicalCoverage.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.entry:pharmacyCoverage.resource.status	required	FinancialResourceStatusCodes http://hl7.org/fhir/ValueSet/fm-status|4.3.0 From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.type	preferred	Pattern Value: DRUGPOL http://hl7.org/fhir/ValueSet/coverage-type From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.subscriber.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.beneficiary.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.relationship	extensible	SubscriberRelationshipCodes http://hl7.org/fhir/ValueSet/subscriber-relationship From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.payor.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.class.type	extensible	CoverageClassCodes http://hl7.org/fhir/ValueSet/coverage-class From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.type	extensible	CoverageCopayTypeCodes http://hl7.org/fhir/ValueSet/coverage-copay-type From the FHIR Standard
Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.exception.type	example	ExampleCoverageFinancialExceptionCodes http://hl7.org/fhir/ValueSet/coverage-financial-exception From the FHIR Standard
Bundle.entry:pharmacyCoverage.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:pharmacyCoverage.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.entry:payer.resource.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Bundle.entry:payer.resource.type	required	Pattern Value: ins https://fhir.developer.gene.com/ValueSet/uapi-org-type From this IG
Bundle.entry:payer.resource.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type From the FHIR Standard
Bundle.entry:payer.resource.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Phone.system	required	Fixed Value: phone http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Fax.system	required	Fixed Value: fax http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Fax.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Email.system	required	Fixed Value: email http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0 From the FHIR Standard
Bundle.entry:payer.resource.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0 From the FHIR Standard
Bundle.entry:payer.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.3.0 From the FHIR Standard
Bundle.entry:payer.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.3.0 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.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-5	error	Bundle.entry, Bundle.entry:messageheader, Bundle.entry:task, Bundle.entry:list, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:practitioner, Bundle.entry:questionnaireresponse, Bundle.entry:medicalCoverage, Bundle.entry:pharmacyCoverage, Bundle.entry:payer	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl 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-8	error	Bundle.entry, Bundle.entry:messageheader, Bundle.entry:task, Bundle.entry:list, Bundle.entry:patient, Bundle.entry:practice, Bundle.entry:practitioner, Bundle.entry:questionnaireresponse, Bundle.entry:medicalCoverage, Bundle.entry:pharmacyCoverage, Bundle.entry:payer	fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
dom-r4b	warning	Bundle.entry:practice.resource.contained, Bundle.entry:medicalCoverage.resource.contained, Bundle.entry:pharmacyCoverage.resource.contained, Bundle.entry:payer.resource.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-2	error	Bundle.entry:practice.resource.address, Bundle.entry:payer.resource.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Bundle.entry:practice.resource.telecom, Bundle.entry:practice.resource.telecom:Phone, Bundle.entry:practice.resource.telecom:Fax, Bundle.entry:payer.resource.telecom, Bundle.entry:payer.resource.telecom:Phone, Bundle.entry:payer.resource.telecom:Fax	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

This structure is derived from Bundle

Summary

Mandatory: 14 elements(2 nested mandatory elements)
Must-Support: 21 elements
Fixed: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

• UAPI MessageHeader (https://fhir.developer.gene.com/StructureDefinition/uapi-messageheader)
• UAPI Patient (https://fhir.developer.gene.com/StructureDefinition/uapi-patient)
• UAPI Organization (https://fhir.developer.gene.com/StructureDefinition/uapi-organization)
• UAPI Practitioner (https://fhir.developer.gene.com/StructureDefinition/uapi-practitioner)
• UAPI Coverage (https://fhir.developer.gene.com/StructureDefinition/uapi-coverage)

Slices

This structure defines the following Slices:

• The element 3 is sliced based on the values of Bundle.entry (Closed)