Universal API Implementation Guide
1.1.19 - ci-build

Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions

Resource Profile: UAPI Bundle - Copay Enrollment

Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-copay-enrollment-bundle Version: 1.1.19
Draft as of 2021-04-28 Responsible: Genentech USIX PE Realm: United States of America flag Computable Name: UapiBundleCopayEnrollment

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

Usage:

Formal Views of Profile Content

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

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... identifier 1..1IdentifierPersistent identifier for the bundle
.... type
..... coding
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
...... code 1..1codeSymbol in syntax defined by the system
Required Pattern: RI
.... value 0..1stringIssuer's bundle UUID. Genentech will generate UUID if not provided.
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: message
... total 0..0
.... entry:All Slices Content/Rules for all slices
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:messageheader S1..1BackboneElementEntry in the bundle - will have a resource or information
..... resource S1..1UapiMessageHeaderA resource that describes a message that is exchanged between systems
.... entry:task S1..1BackboneElementEntry in the bundle - will have a resource or information
..... resource S1..1TaskA resource in the bundle
.... entry:list S1..1BackboneElementEntry in the bundle - will have a resource or information
..... resource S1..1ListA resource in the bundle
.... entry:patient S1..1BackboneElementPatient
..... resource S1..1UapiPatientInformation about an individual or animal receiving health care services
.... entry:practice S1..1BackboneElementEntry in the bundle - will have a resource or information
..... resource 0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... type 1..1CodeableConceptOrganization type for enrollment
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: prov
.... entry:practitioner S1..1BackboneElementEntry in the bundle - will have a resource or information
..... resource S1..1UapiPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
.... entry:questionnaireresponse S1..*BackboneElementEntry in the bundle - will have a resource or information
..... resource S1..1QuestionnaireResponseA resource in the bundle
.... entry:medicalCoverage S0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... type 1..1CodeableConceptCoverage category such as medical or accident
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: HIP
.... entry:pharmacyCoverage S0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... type 1..1CodeableConceptCoverage category such as medical or accident
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: DRUGPOL
.... entry:payer S0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource S0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... type 1..1CodeableConceptOrganization type for enrollment
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: ins

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ1..1IdentifierPersistent identifier for the bundle
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... value Σ0..1stringIssuer's bundle UUID. Genentech will generate UUID if not provided.
Example General: 123456
... type SΣ1..1codedocument | 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
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entry:messageheader SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource S1..1UapiMessageHeaderA resource that describes a message that is exchanged between systems
.... entry:task SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource SΣ1..1TaskA resource in the bundle
.... entry:list SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource SΣ1..1ListA resource in the bundle
.... entry:patient SΣC1..1BackboneElementPatient
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource S1..1UapiPatientInformation about an individual or animal receiving health care services
.... entry:practice SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource C0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
....... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ1..1stringUnique identifier for the organization
Example General: 123456
...... active ?!Σ0..1booleanWhether the organization's record is still in active use
...... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes



Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: prov
...... name SΣC1..1stringMax 255 Characters
...... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
....... telecom:All Slices Content/Rules for all slices
........ system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
........ value SΣ0..1stringThe actual contact point details
........ use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
....... telecom:Phone SC1..*ContactPointA contact detail for the organization
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
....... telecom:Fax SC0..*ContactPointA contact detail for the organization
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
....... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
....... line Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ1..1stringMax 30 Characters
Example General: Erewhon
....... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
....... postalCode Σ1..1stringMax 10 Characters
Example General: 9132
...... contact S0..*BackboneElementContact is required for Practice Organization
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name 0..1HumanNameA name associated with the contact
........ use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
........ family SΣ1..1stringMax 40 Characters
........ given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
....... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
........ telecom:All Slices Content/Rules for all slices
......... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
......... value SΣ0..1stringThe actual contact point details
......... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... entry:practitioner SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource S1..1UapiPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
.... entry:questionnaireresponse SΣC1..*BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource SΣ1..1QuestionnaireResponseA resource in the bundle
.... entry:medicalCoverage SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... PlanYear 0..1stringUAPI Coverage Plan Year
URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
...... ReferenceNumber 0..1stringUAPI Coverage Reference Number
URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
...... IssuedDate 0..1dateUAPI Coverage - Card issuance date
URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

...... type SΣ1..1CodeableConceptCoverage 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
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: HIP
...... subscriber Σ1..1Reference(UAPI Patient | UAPI RelatedPerson)Subscriber to the policy
...... subscriberId SΣ0..1stringID assigned to the subscriber
...... beneficiary Σ1..1Reference(UAPI Patient)Plan beneficiary
...... payor Σ1..*Reference(UAPI Organization)Issuer of the policy
...... class S1..*BackboneElementAdditional coverage classifications
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

........ coding Σ1..1CodingCode defined by a terminology system
......... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
......... code Σ1..1codeSymbol in syntax defined by the system
....... value Σ1..1stringValue associated with the type
....... name Σ1..1stringHuman readable description of the type and value
...... order SΣ1..1positiveIntRelative order of the coverage
...... network SΣ1..1stringInsurer network
.... entry:pharmacyCoverage SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... PlanYear 0..1stringUAPI Coverage Plan Year
URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
...... ReferenceNumber 0..1stringUAPI Coverage Reference Number
URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
...... IssuedDate 0..1dateUAPI Coverage - Card issuance date
URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

...... type SΣ1..1CodeableConceptCoverage 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
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: DRUGPOL
...... subscriber Σ1..1Reference(UAPI Patient | UAPI RelatedPerson)Subscriber to the policy
...... subscriberId SΣ0..1stringID assigned to the subscriber
...... beneficiary Σ1..1Reference(UAPI Patient)Plan beneficiary
...... payor Σ1..*Reference(UAPI Organization)Issuer of the policy
...... class S1..*BackboneElementAdditional coverage classifications
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

........ coding Σ1..1CodingCode defined by a terminology system
......... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
......... code Σ1..1codeSymbol in syntax defined by the system
....... value Σ1..1stringValue associated with the type
....... name Σ1..1stringHuman readable description of the type and value
...... order SΣ1..1positiveIntRelative order of the coverage
...... network SΣ1..1stringInsurer network
.... entry:payer SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource SC0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
....... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ1..1stringUnique identifier for the organization
Example General: 123456
...... active ?!Σ0..1booleanWhether the organization's record is still in active use
...... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes



Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: ins
...... name SΣC1..1stringMax 255 Characters
...... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
....... telecom:All Slices Content/Rules for all slices
........ system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
........ value SΣ0..1stringThe actual contact point details
........ use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
....... telecom:Phone SC1..*ContactPointA contact detail for the organization
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
....... telecom:Fax SC0..*ContactPointA contact detail for the organization
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
....... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
....... line Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ1..1stringMax 30 Characters
Example General: Erewhon
....... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
....... postalCode Σ1..1stringMax 10 Characters
Example General: 9132
...... contact S0..*BackboneElementContact is required for Practice Organization
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name 0..1HumanNameA name associated with the contact
........ use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
........ family SΣ1..1stringMax 40 Characters
........ given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
....... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
........ telecom:All Slices Content/Rules for all slices
......... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
......... value SΣ0..1stringThe actual contact point details
......... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.identifier.userequiredIdentifierUse
Bundle.typerequiredFixed Value: message
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:practice.resource.identifier.userequiredIdentifierUse
Bundle.entry:practice.resource.typerequiredPattern: prov
Bundle.entry:practice.resource.telecom.systemrequiredContactPointSystem
Bundle.entry:practice.resource.telecom.userequiredContactPointUse
Bundle.entry:practice.resource.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:practice.resource.telecom:Phone.userequiredContactPointUse
Bundle.entry:practice.resource.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:practice.resource.telecom:Fax.userequiredContactPointUse
Bundle.entry:practice.resource.address.userequiredAddressUse
Bundle.entry:practice.resource.contact.name.userequiredNameUse
Bundle.entry:practice.resource.contact.telecom.systemrequiredContactPointSystem
Bundle.entry:practice.resource.contact.telecom.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:practice.resource.contact.telecom:Phone.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:practice.resource.contact.telecom:Fax.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Email.systemrequiredFixed Value: email
Bundle.entry:practice.resource.contact.telecom:Email.userequiredContactPointUse
Bundle.entry:medicalCoverage.resource.statusrequiredFinancialResourceStatusCodes
Bundle.entry:medicalCoverage.resource.typepreferredPattern: HIP
Bundle.entry:medicalCoverage.resource.class.typeextensibleCoverageClassCodes
Bundle.entry:pharmacyCoverage.resource.statusrequiredFinancialResourceStatusCodes
Bundle.entry:pharmacyCoverage.resource.typepreferredPattern: DRUGPOL
Bundle.entry:pharmacyCoverage.resource.class.typeextensibleCoverageClassCodes
Bundle.entry:payer.resource.identifier.userequiredIdentifierUse
Bundle.entry:payer.resource.typerequiredPattern: ins
Bundle.entry:payer.resource.telecom.systemrequiredContactPointSystem
Bundle.entry:payer.resource.telecom.userequiredContactPointUse
Bundle.entry:payer.resource.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:payer.resource.telecom:Phone.userequiredContactPointUse
Bundle.entry:payer.resource.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:payer.resource.telecom:Fax.userequiredContactPointUse
Bundle.entry:payer.resource.address.userequiredAddressUse
Bundle.entry:payer.resource.contact.name.userequiredNameUse
Bundle.entry:payer.resource.contact.telecom.systemrequiredContactPointSystem
Bundle.entry:payer.resource.contact.telecom.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:payer.resource.contact.telecom:Phone.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:payer.resource.contact.telecom:Fax.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Email.systemrequiredFixed Value: email
Bundle.entry:payer.resource.contact.telecom:Email.userequiredContactPointUse
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ1..1IdentifierPersistent identifier for the bundle
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Required Pattern: RI
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringIssuer's bundle UUID. Genentech will generate UUID if not provided.
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... type SΣ1..1codedocument | 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..1instantWhen the bundle was assembled
... link Σ0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... Slices for entry SΣC7..*BackboneElementEntry 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
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ0..1ResourceA resource in the bundle
.... entry:messageheader SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S1..1UapiMessageHeaderA resource that describes a message that is exchanged between systems
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:task SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ1..1TaskA resource in the bundle
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:list SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ1..1ListA resource in the bundle
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:patient SΣC1..1BackboneElementPatient
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S1..1UapiPatientInformation about an individual or animal receiving health care services
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:practice SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... id Σ0..1idLogical id of this artifact
...... meta Σ0..1MetaMetadata about the resource
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... text 0..1NarrativeText summary of the resource, for human interpretation
...... contained 0..*ResourceContained, inline Resources
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
....... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
....... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ1..1stringUnique identifier for the organization
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... active ?!Σ0..1booleanWhether the organization's record is still in active use
...... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes



Required Pattern: At least the following
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1idUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: prov
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... name SΣC1..1stringMax 255 Characters
...... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
...... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
....... telecom:All Slices Content/Rules for all slices
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
........ value SΣ0..1stringThe actual contact point details
........ use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
....... telecom:Phone SC1..*ContactPointA contact detail for the organization
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
........ value Σ0..1stringPhone (10 digit numeric values only)
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
....... telecom:Fax SC0..*ContactPointA contact detail for the organization
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
........ value Σ0..1stringFax (10 digit numeric values only)
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
...... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
....... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
....... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
....... line Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ1..1stringMax 30 Characters
Example General: Erewhon
....... district Σ0..1stringDistrict name (aka county)
Example General: Madison
....... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
....... postalCode Σ1..1stringMax 10 Characters
Example General: 9132
....... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
....... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
...... contact S0..*BackboneElementContact is required for Practice Organization
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

....... name 0..1HumanNameA name associated with the contact
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
........ text Σ0..1stringText representation of the full name
........ family SΣ1..1stringMax 40 Characters
........ given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
........ prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
........ suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
........ period Σ0..1PeriodTime period when name was/is in use
....... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
........ telecom:All Slices Content/Rules for all slices
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
......... value SΣ0..1stringThe actual contact point details
......... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
......... value Σ0..1stringPhone (10 digit numeric values only)
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
......... value Σ0..1stringFax (10 digit numeric values only)
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
......... value Σ0..1stringEmail format
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
....... address 0..1AddressVisiting or postal addresses for the contact
...... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:practitioner SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S1..1UapiPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:questionnaireresponse SΣC1..*BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ1..1QuestionnaireResponseA resource in the bundle
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:medicalCoverage SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... id Σ0..1idLogical id of this artifact
...... meta Σ0..1MetaMetadata about the resource
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... text 0..1NarrativeText summary of the resource, for human interpretation
...... contained 0..*ResourceContained, inline Resources
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... PlanYear 0..1stringUAPI Coverage Plan Year
URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
...... ReferenceNumber 0..1stringUAPI Coverage Reference Number
URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
...... IssuedDate 0..1dateUAPI Coverage - Card issuance date
URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier Σ0..*IdentifierBusiness Identifier for the coverage
...... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

...... type SΣ1..1CodeableConceptCoverage 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
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1idUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: HIP
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
...... subscriber Σ1..1Reference(UAPI Patient | UAPI RelatedPerson)Subscriber to the policy
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPatient or RelatedPerson resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... subscriberId SΣ0..1stringID assigned to the subscriber
...... beneficiary Σ1..1Reference(UAPI Patient)Plan beneficiary
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPatient resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... dependent Σ0..1stringDependent number
...... relationship 0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

...... period Σ0..1PeriodCoverage start and end dates
...... payor Σ1..*Reference(UAPI Organization)Issuer of the policy
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPayor Orginization resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Organization
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... class S1..*BackboneElementAdditional coverage classifications
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ1..1CodingCode defined by a terminology system
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
......... version Σ0..1stringVersion of the system - if relevant
......... code Σ1..1codeSymbol in syntax defined by the system
......... display Σ0..1stringRepresentation defined by the system
......... userSelected Σ0..1booleanIf this coding was chosen directly by the user
........ text Σ0..1stringPlain text representation of the concept
....... value Σ1..1stringValue associated with the type
....... name Σ1..1stringHuman readable description of the type and value
...... order SΣ1..1positiveIntRelative order of the coverage
...... network SΣ1..1stringInsurer network
...... costToBeneficiary 0..*BackboneElementPatient payments for services/products
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ0..1CodeableConceptCost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

....... value[x] Σ1..1The amount or percentage due from the beneficiary
........ valueQuantityQuantity(SimpleQuantity)
........ valueMoneyMoney
....... exception 0..*BackboneElementExceptions for patient payments
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ type Σ1..1CodeableConceptException category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

........ period Σ0..1PeriodThe effective period of the exception
...... subrogation 0..1booleanReimbursement to insurer
...... contract 0..*Reference(Contract)Contract details
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:pharmacyCoverage SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... id Σ0..1idLogical id of this artifact
...... meta Σ0..1MetaMetadata about the resource
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... text 0..1NarrativeText summary of the resource, for human interpretation
...... contained 0..*ResourceContained, inline Resources
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... PlanYear 0..1stringUAPI Coverage Plan Year
URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
...... ReferenceNumber 0..1stringUAPI Coverage Reference Number
URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
...... IssuedDate 0..1dateUAPI Coverage - Card issuance date
URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier Σ0..*IdentifierBusiness Identifier for the coverage
...... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

...... type SΣ1..1CodeableConceptCoverage 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
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1idUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: DRUGPOL
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
...... subscriber Σ1..1Reference(UAPI Patient | UAPI RelatedPerson)Subscriber to the policy
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPatient or RelatedPerson resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... subscriberId SΣ0..1stringID assigned to the subscriber
...... beneficiary Σ1..1Reference(UAPI Patient)Plan beneficiary
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPatient resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... dependent Σ0..1stringDependent number
...... relationship 0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

...... period Σ0..1PeriodCoverage start and end dates
...... payor Σ1..*Reference(UAPI Organization)Issuer of the policy
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPayor Orginization resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Organization
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... class S1..*BackboneElementAdditional coverage classifications
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ1..1CodingCode defined by a terminology system
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
......... version Σ0..1stringVersion of the system - if relevant
......... code Σ1..1codeSymbol in syntax defined by the system
......... display Σ0..1stringRepresentation defined by the system
......... userSelected Σ0..1booleanIf this coding was chosen directly by the user
........ text Σ0..1stringPlain text representation of the concept
....... value Σ1..1stringValue associated with the type
....... name Σ1..1stringHuman readable description of the type and value
...... order SΣ1..1positiveIntRelative order of the coverage
...... network SΣ1..1stringInsurer network
...... costToBeneficiary 0..*BackboneElementPatient payments for services/products
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ0..1CodeableConceptCost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

....... value[x] Σ1..1The amount or percentage due from the beneficiary
........ valueQuantityQuantity(SimpleQuantity)
........ valueMoneyMoney
....... exception 0..*BackboneElementExceptions for patient payments
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ type Σ1..1CodeableConceptException category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

........ period Σ0..1PeriodThe effective period of the exception
...... subrogation 0..1booleanReimbursement to insurer
...... contract 0..*Reference(Contract)Contract details
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:payer SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SC0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... id Σ0..1idLogical id of this artifact
...... meta Σ0..1MetaMetadata about the resource
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... text 0..1NarrativeText summary of the resource, for human interpretation
...... contained 0..*ResourceContained, inline Resources
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
....... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
....... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ1..1stringUnique identifier for the organization
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... active ?!Σ0..1booleanWhether the organization's record is still in active use
...... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes



Required Pattern: At least the following
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1idUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: ins
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... name SΣC1..1stringMax 255 Characters
...... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
...... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
....... telecom:All Slices Content/Rules for all slices
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
........ value SΣ0..1stringThe actual contact point details
........ use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
....... telecom:Phone SC1..*ContactPointA contact detail for the organization
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
........ value Σ0..1stringPhone (10 digit numeric values only)
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
....... telecom:Fax SC0..*ContactPointA contact detail for the organization
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
........ value Σ0..1stringFax (10 digit numeric values only)
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
...... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
....... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
....... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
....... line Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ1..1stringMax 30 Characters
Example General: Erewhon
....... district Σ0..1stringDistrict name (aka county)
Example General: Madison
....... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
....... postalCode Σ1..1stringMax 10 Characters
Example General: 9132
....... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
....... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
...... contact S0..*BackboneElementContact is required for Practice Organization
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

....... name 0..1HumanNameA name associated with the contact
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
........ text Σ0..1stringText representation of the full name
........ family SΣ1..1stringMax 40 Characters
........ given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
........ prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
........ suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
........ period Σ0..1PeriodTime period when name was/is in use
....... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
........ telecom:All Slices Content/Rules for all slices
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
......... value SΣ0..1stringThe actual contact point details
......... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
......... value Σ0..1stringPhone (10 digit numeric values only)
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
......... value Σ0..1stringFax (10 digit numeric values only)
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
......... value Σ0..1stringEmail format
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
....... address 0..1AddressVisiting or postal addresses for the contact
...... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.identifier.userequiredIdentifierUse
Bundle.identifier.typeextensibleIdentifier Type Codes
Bundle.typerequiredFixed Value: message
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:messageheader.search.moderequiredSearchEntryMode
Bundle.entry:messageheader.request.methodrequiredHTTPVerb
Bundle.entry:task.search.moderequiredSearchEntryMode
Bundle.entry:task.request.methodrequiredHTTPVerb
Bundle.entry:list.search.moderequiredSearchEntryMode
Bundle.entry:list.request.methodrequiredHTTPVerb
Bundle.entry:patient.search.moderequiredSearchEntryMode
Bundle.entry:patient.request.methodrequiredHTTPVerb
Bundle.entry:practice.resource.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:practice.resource.identifier.userequiredIdentifierUse
Bundle.entry:practice.resource.identifier.typeextensibleIdentifier Type Codes
Bundle.entry:practice.resource.typerequiredPattern: prov
Bundle.entry:practice.resource.telecom.systemrequiredContactPointSystem
Bundle.entry:practice.resource.telecom.userequiredContactPointUse
Bundle.entry:practice.resource.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:practice.resource.telecom:Phone.userequiredContactPointUse
Bundle.entry:practice.resource.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:practice.resource.telecom:Fax.userequiredContactPointUse
Bundle.entry:practice.resource.address.userequiredAddressUse
Bundle.entry:practice.resource.address.typerequiredAddressType
Bundle.entry:practice.resource.contact.purposeextensibleContactEntityType
Bundle.entry:practice.resource.contact.name.userequiredNameUse
Bundle.entry:practice.resource.contact.telecom.systemrequiredContactPointSystem
Bundle.entry:practice.resource.contact.telecom.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:practice.resource.contact.telecom:Phone.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:practice.resource.contact.telecom:Fax.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Email.systemrequiredFixed Value: email
Bundle.entry:practice.resource.contact.telecom:Email.userequiredContactPointUse
Bundle.entry:practice.search.moderequiredSearchEntryMode
Bundle.entry:practice.request.methodrequiredHTTPVerb
Bundle.entry:practitioner.search.moderequiredSearchEntryMode
Bundle.entry:practitioner.request.methodrequiredHTTPVerb
Bundle.entry:questionnaireresponse.search.moderequiredSearchEntryMode
Bundle.entry:questionnaireresponse.request.methodrequiredHTTPVerb
Bundle.entry:medicalCoverage.resource.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:medicalCoverage.resource.statusrequiredFinancialResourceStatusCodes
Bundle.entry:medicalCoverage.resource.typepreferredPattern: HIP
Bundle.entry:medicalCoverage.resource.subscriber.typeextensibleResourceType
Bundle.entry:medicalCoverage.resource.beneficiary.typeextensiblePattern: Patient
Bundle.entry:medicalCoverage.resource.relationshipextensibleSubscriberRelationshipCodes
Bundle.entry:medicalCoverage.resource.payor.typeextensiblePattern: Organization
Bundle.entry:medicalCoverage.resource.class.typeextensibleCoverageClassCodes
Bundle.entry:medicalCoverage.resource.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
Bundle.entry:medicalCoverage.resource.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes
Bundle.entry:medicalCoverage.search.moderequiredSearchEntryMode
Bundle.entry:medicalCoverage.request.methodrequiredHTTPVerb
Bundle.entry:pharmacyCoverage.resource.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:pharmacyCoverage.resource.statusrequiredFinancialResourceStatusCodes
Bundle.entry:pharmacyCoverage.resource.typepreferredPattern: DRUGPOL
Bundle.entry:pharmacyCoverage.resource.subscriber.typeextensibleResourceType
Bundle.entry:pharmacyCoverage.resource.beneficiary.typeextensiblePattern: Patient
Bundle.entry:pharmacyCoverage.resource.relationshipextensibleSubscriberRelationshipCodes
Bundle.entry:pharmacyCoverage.resource.payor.typeextensiblePattern: Organization
Bundle.entry:pharmacyCoverage.resource.class.typeextensibleCoverageClassCodes
Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes
Bundle.entry:pharmacyCoverage.search.moderequiredSearchEntryMode
Bundle.entry:pharmacyCoverage.request.methodrequiredHTTPVerb
Bundle.entry:payer.resource.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:payer.resource.identifier.userequiredIdentifierUse
Bundle.entry:payer.resource.identifier.typeextensibleIdentifier Type Codes
Bundle.entry:payer.resource.typerequiredPattern: ins
Bundle.entry:payer.resource.telecom.systemrequiredContactPointSystem
Bundle.entry:payer.resource.telecom.userequiredContactPointUse
Bundle.entry:payer.resource.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:payer.resource.telecom:Phone.userequiredContactPointUse
Bundle.entry:payer.resource.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:payer.resource.telecom:Fax.userequiredContactPointUse
Bundle.entry:payer.resource.address.userequiredAddressUse
Bundle.entry:payer.resource.address.typerequiredAddressType
Bundle.entry:payer.resource.contact.purposeextensibleContactEntityType
Bundle.entry:payer.resource.contact.name.userequiredNameUse
Bundle.entry:payer.resource.contact.telecom.systemrequiredContactPointSystem
Bundle.entry:payer.resource.contact.telecom.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:payer.resource.contact.telecom:Phone.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:payer.resource.contact.telecom:Fax.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Email.systemrequiredFixed Value: email
Bundle.entry:payer.resource.contact.telecom:Email.userequiredContactPointUse
Bundle.entry:payer.search.moderequiredSearchEntryMode
Bundle.entry:payer.request.methodrequiredHTTPVerb

This structure is derived from Bundle

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the values of type:resource, pattern:resource.ofType(Organization).type, pattern:resource.ofType(Coverage).type (Closed)

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... identifier 1..1IdentifierPersistent identifier for the bundle
.... type
..... coding
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
...... code 1..1codeSymbol in syntax defined by the system
Required Pattern: RI
.... value 0..1stringIssuer's bundle UUID. Genentech will generate UUID if not provided.
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: message
... total 0..0
.... entry:All Slices Content/Rules for all slices
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:messageheader S1..1BackboneElementEntry in the bundle - will have a resource or information
..... resource S1..1UapiMessageHeaderA resource that describes a message that is exchanged between systems
.... entry:task S1..1BackboneElementEntry in the bundle - will have a resource or information
..... resource S1..1TaskA resource in the bundle
.... entry:list S1..1BackboneElementEntry in the bundle - will have a resource or information
..... resource S1..1ListA resource in the bundle
.... entry:patient S1..1BackboneElementPatient
..... resource S1..1UapiPatientInformation about an individual or animal receiving health care services
.... entry:practice S1..1BackboneElementEntry in the bundle - will have a resource or information
..... resource 0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... type 1..1CodeableConceptOrganization type for enrollment
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: prov
.... entry:practitioner S1..1BackboneElementEntry in the bundle - will have a resource or information
..... resource S1..1UapiPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
.... entry:questionnaireresponse S1..*BackboneElementEntry in the bundle - will have a resource or information
..... resource S1..1QuestionnaireResponseA resource in the bundle
.... entry:medicalCoverage S0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... type 1..1CodeableConceptCoverage category such as medical or accident
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: HIP
.... entry:pharmacyCoverage S0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... type 1..1CodeableConceptCoverage category such as medical or accident
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: DRUGPOL
.... entry:payer S0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource S0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... type 1..1CodeableConceptOrganization type for enrollment
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: ins

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ1..1IdentifierPersistent identifier for the bundle
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... value Σ0..1stringIssuer's bundle UUID. Genentech will generate UUID if not provided.
Example General: 123456
... type SΣ1..1codedocument | 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
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entry:messageheader SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource S1..1UapiMessageHeaderA resource that describes a message that is exchanged between systems
.... entry:task SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource SΣ1..1TaskA resource in the bundle
.... entry:list SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource SΣ1..1ListA resource in the bundle
.... entry:patient SΣC1..1BackboneElementPatient
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource S1..1UapiPatientInformation about an individual or animal receiving health care services
.... entry:practice SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource C0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
....... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ1..1stringUnique identifier for the organization
Example General: 123456
...... active ?!Σ0..1booleanWhether the organization's record is still in active use
...... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes



Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: prov
...... name SΣC1..1stringMax 255 Characters
...... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
....... telecom:All Slices Content/Rules for all slices
........ system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
........ value SΣ0..1stringThe actual contact point details
........ use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
....... telecom:Phone SC1..*ContactPointA contact detail for the organization
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
....... telecom:Fax SC0..*ContactPointA contact detail for the organization
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
....... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
....... line Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ1..1stringMax 30 Characters
Example General: Erewhon
....... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
....... postalCode Σ1..1stringMax 10 Characters
Example General: 9132
...... contact S0..*BackboneElementContact is required for Practice Organization
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name 0..1HumanNameA name associated with the contact
........ use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
........ family SΣ1..1stringMax 40 Characters
........ given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
....... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
........ telecom:All Slices Content/Rules for all slices
......... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
......... value SΣ0..1stringThe actual contact point details
......... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... entry:practitioner SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource S1..1UapiPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
.... entry:questionnaireresponse SΣC1..*BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource SΣ1..1QuestionnaireResponseA resource in the bundle
.... entry:medicalCoverage SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... PlanYear 0..1stringUAPI Coverage Plan Year
URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
...... ReferenceNumber 0..1stringUAPI Coverage Reference Number
URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
...... IssuedDate 0..1dateUAPI Coverage - Card issuance date
URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

...... type SΣ1..1CodeableConceptCoverage 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
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: HIP
...... subscriber Σ1..1Reference(UAPI Patient | UAPI RelatedPerson)Subscriber to the policy
...... subscriberId SΣ0..1stringID assigned to the subscriber
...... beneficiary Σ1..1Reference(UAPI Patient)Plan beneficiary
...... payor Σ1..*Reference(UAPI Organization)Issuer of the policy
...... class S1..*BackboneElementAdditional coverage classifications
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

........ coding Σ1..1CodingCode defined by a terminology system
......... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
......... code Σ1..1codeSymbol in syntax defined by the system
....... value Σ1..1stringValue associated with the type
....... name Σ1..1stringHuman readable description of the type and value
...... order SΣ1..1positiveIntRelative order of the coverage
...... network SΣ1..1stringInsurer network
.... entry:pharmacyCoverage SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... PlanYear 0..1stringUAPI Coverage Plan Year
URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
...... ReferenceNumber 0..1stringUAPI Coverage Reference Number
URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
...... IssuedDate 0..1dateUAPI Coverage - Card issuance date
URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

...... type SΣ1..1CodeableConceptCoverage 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
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: DRUGPOL
...... subscriber Σ1..1Reference(UAPI Patient | UAPI RelatedPerson)Subscriber to the policy
...... subscriberId SΣ0..1stringID assigned to the subscriber
...... beneficiary Σ1..1Reference(UAPI Patient)Plan beneficiary
...... payor Σ1..*Reference(UAPI Organization)Issuer of the policy
...... class S1..*BackboneElementAdditional coverage classifications
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

........ coding Σ1..1CodingCode defined by a terminology system
......... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
......... code Σ1..1codeSymbol in syntax defined by the system
....... value Σ1..1stringValue associated with the type
....... name Σ1..1stringHuman readable description of the type and value
...... order SΣ1..1positiveIntRelative order of the coverage
...... network SΣ1..1stringInsurer network
.... entry:payer SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... resource SC0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
....... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ1..1stringUnique identifier for the organization
Example General: 123456
...... active ?!Σ0..1booleanWhether the organization's record is still in active use
...... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes



Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: ins
...... name SΣC1..1stringMax 255 Characters
...... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
....... telecom:All Slices Content/Rules for all slices
........ system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
........ value SΣ0..1stringThe actual contact point details
........ use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
....... telecom:Phone SC1..*ContactPointA contact detail for the organization
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
....... telecom:Fax SC0..*ContactPointA contact detail for the organization
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
....... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
....... line Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ1..1stringMax 30 Characters
Example General: Erewhon
....... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
....... postalCode Σ1..1stringMax 10 Characters
Example General: 9132
...... contact S0..*BackboneElementContact is required for Practice Organization
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name 0..1HumanNameA name associated with the contact
........ use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
........ family SΣ1..1stringMax 40 Characters
........ given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
....... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
........ telecom:All Slices Content/Rules for all slices
......... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
......... value SΣ0..1stringThe actual contact point details
......... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.identifier.userequiredIdentifierUse
Bundle.typerequiredFixed Value: message
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:practice.resource.identifier.userequiredIdentifierUse
Bundle.entry:practice.resource.typerequiredPattern: prov
Bundle.entry:practice.resource.telecom.systemrequiredContactPointSystem
Bundle.entry:practice.resource.telecom.userequiredContactPointUse
Bundle.entry:practice.resource.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:practice.resource.telecom:Phone.userequiredContactPointUse
Bundle.entry:practice.resource.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:practice.resource.telecom:Fax.userequiredContactPointUse
Bundle.entry:practice.resource.address.userequiredAddressUse
Bundle.entry:practice.resource.contact.name.userequiredNameUse
Bundle.entry:practice.resource.contact.telecom.systemrequiredContactPointSystem
Bundle.entry:practice.resource.contact.telecom.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:practice.resource.contact.telecom:Phone.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:practice.resource.contact.telecom:Fax.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Email.systemrequiredFixed Value: email
Bundle.entry:practice.resource.contact.telecom:Email.userequiredContactPointUse
Bundle.entry:medicalCoverage.resource.statusrequiredFinancialResourceStatusCodes
Bundle.entry:medicalCoverage.resource.typepreferredPattern: HIP
Bundle.entry:medicalCoverage.resource.class.typeextensibleCoverageClassCodes
Bundle.entry:pharmacyCoverage.resource.statusrequiredFinancialResourceStatusCodes
Bundle.entry:pharmacyCoverage.resource.typepreferredPattern: DRUGPOL
Bundle.entry:pharmacyCoverage.resource.class.typeextensibleCoverageClassCodes
Bundle.entry:payer.resource.identifier.userequiredIdentifierUse
Bundle.entry:payer.resource.typerequiredPattern: ins
Bundle.entry:payer.resource.telecom.systemrequiredContactPointSystem
Bundle.entry:payer.resource.telecom.userequiredContactPointUse
Bundle.entry:payer.resource.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:payer.resource.telecom:Phone.userequiredContactPointUse
Bundle.entry:payer.resource.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:payer.resource.telecom:Fax.userequiredContactPointUse
Bundle.entry:payer.resource.address.userequiredAddressUse
Bundle.entry:payer.resource.contact.name.userequiredNameUse
Bundle.entry:payer.resource.contact.telecom.systemrequiredContactPointSystem
Bundle.entry:payer.resource.contact.telecom.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:payer.resource.contact.telecom:Phone.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:payer.resource.contact.telecom:Fax.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Email.systemrequiredFixed Value: email
Bundle.entry:payer.resource.contact.telecom:Email.userequiredContactPointUse

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ1..1IdentifierPersistent identifier for the bundle
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Required Pattern: RI
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringIssuer's bundle UUID. Genentech will generate UUID if not provided.
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... type SΣ1..1codedocument | 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..1instantWhen the bundle was assembled
... link Σ0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... Slices for entry SΣC7..*BackboneElementEntry 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
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ0..1ResourceA resource in the bundle
.... entry:messageheader SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S1..1UapiMessageHeaderA resource that describes a message that is exchanged between systems
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:task SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ1..1TaskA resource in the bundle
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:list SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ1..1ListA resource in the bundle
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:patient SΣC1..1BackboneElementPatient
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S1..1UapiPatientInformation about an individual or animal receiving health care services
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:practice SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... id Σ0..1idLogical id of this artifact
...... meta Σ0..1MetaMetadata about the resource
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... text 0..1NarrativeText summary of the resource, for human interpretation
...... contained 0..*ResourceContained, inline Resources
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
....... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
....... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ1..1stringUnique identifier for the organization
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... active ?!Σ0..1booleanWhether the organization's record is still in active use
...... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes



Required Pattern: At least the following
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1idUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: prov
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... name SΣC1..1stringMax 255 Characters
...... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
...... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
....... telecom:All Slices Content/Rules for all slices
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
........ value SΣ0..1stringThe actual contact point details
........ use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
....... telecom:Phone SC1..*ContactPointA contact detail for the organization
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
........ value Σ0..1stringPhone (10 digit numeric values only)
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
....... telecom:Fax SC0..*ContactPointA contact detail for the organization
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
........ value Σ0..1stringFax (10 digit numeric values only)
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
...... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
....... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
....... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
....... line Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ1..1stringMax 30 Characters
Example General: Erewhon
....... district Σ0..1stringDistrict name (aka county)
Example General: Madison
....... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
....... postalCode Σ1..1stringMax 10 Characters
Example General: 9132
....... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
....... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
...... contact S0..*BackboneElementContact is required for Practice Organization
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

....... name 0..1HumanNameA name associated with the contact
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
........ text Σ0..1stringText representation of the full name
........ family SΣ1..1stringMax 40 Characters
........ given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
........ prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
........ suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
........ period Σ0..1PeriodTime period when name was/is in use
....... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
........ telecom:All Slices Content/Rules for all slices
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
......... value SΣ0..1stringThe actual contact point details
......... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
......... value Σ0..1stringPhone (10 digit numeric values only)
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
......... value Σ0..1stringFax (10 digit numeric values only)
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
......... value Σ0..1stringEmail format
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
....... address 0..1AddressVisiting or postal addresses for the contact
...... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:practitioner SΣC1..1BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S1..1UapiPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:questionnaireresponse SΣC1..*BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SΣ1..1QuestionnaireResponseA resource in the bundle
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:medicalCoverage SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... id Σ0..1idLogical id of this artifact
...... meta Σ0..1MetaMetadata about the resource
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... text 0..1NarrativeText summary of the resource, for human interpretation
...... contained 0..*ResourceContained, inline Resources
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... PlanYear 0..1stringUAPI Coverage Plan Year
URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
...... ReferenceNumber 0..1stringUAPI Coverage Reference Number
URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
...... IssuedDate 0..1dateUAPI Coverage - Card issuance date
URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier Σ0..*IdentifierBusiness Identifier for the coverage
...... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

...... type SΣ1..1CodeableConceptCoverage 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
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1idUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: HIP
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
...... subscriber Σ1..1Reference(UAPI Patient | UAPI RelatedPerson)Subscriber to the policy
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPatient or RelatedPerson resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... subscriberId SΣ0..1stringID assigned to the subscriber
...... beneficiary Σ1..1Reference(UAPI Patient)Plan beneficiary
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPatient resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... dependent Σ0..1stringDependent number
...... relationship 0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

...... period Σ0..1PeriodCoverage start and end dates
...... payor Σ1..*Reference(UAPI Organization)Issuer of the policy
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPayor Orginization resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Organization
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... class S1..*BackboneElementAdditional coverage classifications
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ1..1CodingCode defined by a terminology system
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
......... version Σ0..1stringVersion of the system - if relevant
......... code Σ1..1codeSymbol in syntax defined by the system
......... display Σ0..1stringRepresentation defined by the system
......... userSelected Σ0..1booleanIf this coding was chosen directly by the user
........ text Σ0..1stringPlain text representation of the concept
....... value Σ1..1stringValue associated with the type
....... name Σ1..1stringHuman readable description of the type and value
...... order SΣ1..1positiveIntRelative order of the coverage
...... network SΣ1..1stringInsurer network
...... costToBeneficiary 0..*BackboneElementPatient payments for services/products
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ0..1CodeableConceptCost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

....... value[x] Σ1..1The amount or percentage due from the beneficiary
........ valueQuantityQuantity(SimpleQuantity)
........ valueMoneyMoney
....... exception 0..*BackboneElementExceptions for patient payments
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ type Σ1..1CodeableConceptException category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

........ period Σ0..1PeriodThe effective period of the exception
...... subrogation 0..1booleanReimbursement to insurer
...... contract 0..*Reference(Contract)Contract details
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:pharmacyCoverage SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S0..1UapiCoverageInsurance or medical plan or a payment agreement
...... id Σ0..1idLogical id of this artifact
...... meta Σ0..1MetaMetadata about the resource
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... text 0..1NarrativeText summary of the resource, for human interpretation
...... contained 0..*ResourceContained, inline Resources
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... PlanYear 0..1stringUAPI Coverage Plan Year
URL: https://fhir.developer.gene.com/StructureDefinition/PlanYear
...... ReferenceNumber 0..1stringUAPI Coverage Reference Number
URL: https://fhir.developer.gene.com/StructureDefinition/ReferenceNumber
...... IssuedDate 0..1dateUAPI Coverage - Card issuance date
URL: https://fhir.developer.gene.com/StructureDefinition/IssuedDate
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier Σ0..*IdentifierBusiness Identifier for the coverage
...... status ?!Σ1..1codeactive | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.

...... type SΣ1..1CodeableConceptCoverage 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
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1idUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: DRUGPOL
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
...... subscriber Σ1..1Reference(UAPI Patient | UAPI RelatedPerson)Subscriber to the policy
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPatient or RelatedPerson resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... subscriberId SΣ0..1stringID assigned to the subscriber
...... beneficiary Σ1..1Reference(UAPI Patient)Plan beneficiary
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPatient resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Patient
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... dependent Σ0..1stringDependent number
...... relationship 0..1CodeableConceptBeneficiary relationship to the subscriber
Binding: SubscriberRelationshipCodes (extensible): The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

...... period Σ0..1PeriodCoverage start and end dates
...... payor Σ1..*Reference(UAPI Organization)Issuer of the policy
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringPayor Orginization resource UUID
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
Required Pattern: Organization
....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ0..1stringText alternative for the resource
...... class S1..*BackboneElementAdditional coverage classifications
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ1..1CodeableConceptType of class such as 'group' or 'plan'
Binding: CoverageClassCodes (extensible): The policy classifications, eg. Group, Plan, Class, etc.

........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ1..1CodingCode defined by a terminology system
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/coverage-class
......... version Σ0..1stringVersion of the system - if relevant
......... code Σ1..1codeSymbol in syntax defined by the system
......... display Σ0..1stringRepresentation defined by the system
......... userSelected Σ0..1booleanIf this coding was chosen directly by the user
........ text Σ0..1stringPlain text representation of the concept
....... value Σ1..1stringValue associated with the type
....... name Σ1..1stringHuman readable description of the type and value
...... order SΣ1..1positiveIntRelative order of the coverage
...... network SΣ1..1stringInsurer network
...... costToBeneficiary 0..*BackboneElementPatient payments for services/products
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type Σ0..1CodeableConceptCost category
Binding: CoverageCopayTypeCodes (extensible): The types of services to which patient copayments are specified.

....... value[x] Σ1..1The amount or percentage due from the beneficiary
........ valueQuantityQuantity(SimpleQuantity)
........ valueMoneyMoney
....... exception 0..*BackboneElementExceptions for patient payments
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ type Σ1..1CodeableConceptException category
Binding: ExampleCoverageFinancialExceptionCodes (example): The types of exceptions from the part or full value of financial obligations such as copays.

........ period Σ0..1PeriodThe effective period of the exception
...... subrogation 0..1booleanReimbursement to insurer
...... contract 0..*Reference(Contract)Contract details
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:payer SΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource SC0..1UapiOrganizationA grouping of people or organizations with a common purpose
...... id Σ0..1idLogical id of this artifact
...... meta Σ0..1MetaMetadata about the resource
...... implicitRules ?!Σ0..1uriA set of rules under which this content was created
...... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
...... text 0..1NarrativeText summary of the resource, for human interpretation
...... contained 0..*ResourceContained, inline Resources
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
...... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
....... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
....... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ1..1stringUnique identifier for the organization
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... active ?!Σ0..1booleanWhether the organization's record is still in active use
...... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes



Required Pattern: At least the following
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1idUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: ins
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... name SΣC1..1stringMax 255 Characters
...... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
...... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
....... telecom:All Slices Content/Rules for all slices
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
........ value SΣ0..1stringThe actual contact point details
........ use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
....... telecom:Phone SC1..*ContactPointA contact detail for the organization
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
........ value Σ0..1stringPhone (10 digit numeric values only)
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
....... telecom:Fax SC0..*ContactPointA contact detail for the organization
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
........ value Σ0..1stringFax (10 digit numeric values only)
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
...... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
....... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
....... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
....... line Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
....... city Σ1..1stringMax 30 Characters
Example General: Erewhon
....... district Σ0..1stringDistrict name (aka county)
Example General: Madison
....... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
....... postalCode Σ1..1stringMax 10 Characters
Example General: 9132
....... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
....... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
...... contact S0..*BackboneElementContact is required for Practice Organization
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

....... name 0..1HumanNameA name associated with the contact
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
........ text Σ0..1stringText representation of the full name
........ family SΣ1..1stringMax 40 Characters
........ given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
........ prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
........ suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
........ period Σ0..1PeriodTime period when name was/is in use
....... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
........ telecom:All Slices Content/Rules for all slices
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
......... value SΣ0..1stringThe actual contact point details
......... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
......... value Σ0..1stringPhone (10 digit numeric values only)
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
......... value Σ0..1stringFax (10 digit numeric values only)
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
........ telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
......... id 0..1idUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
......... value Σ0..1stringEmail format
......... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
......... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
......... period Σ0..1PeriodTime period when the contact point was/is in use
....... address 0..1AddressVisiting or postal addresses for the contact
...... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization
..... search ΣC0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.identifier.userequiredIdentifierUse
Bundle.identifier.typeextensibleIdentifier Type Codes
Bundle.typerequiredFixed Value: message
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:messageheader.search.moderequiredSearchEntryMode
Bundle.entry:messageheader.request.methodrequiredHTTPVerb
Bundle.entry:task.search.moderequiredSearchEntryMode
Bundle.entry:task.request.methodrequiredHTTPVerb
Bundle.entry:list.search.moderequiredSearchEntryMode
Bundle.entry:list.request.methodrequiredHTTPVerb
Bundle.entry:patient.search.moderequiredSearchEntryMode
Bundle.entry:patient.request.methodrequiredHTTPVerb
Bundle.entry:practice.resource.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:practice.resource.identifier.userequiredIdentifierUse
Bundle.entry:practice.resource.identifier.typeextensibleIdentifier Type Codes
Bundle.entry:practice.resource.typerequiredPattern: prov
Bundle.entry:practice.resource.telecom.systemrequiredContactPointSystem
Bundle.entry:practice.resource.telecom.userequiredContactPointUse
Bundle.entry:practice.resource.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:practice.resource.telecom:Phone.userequiredContactPointUse
Bundle.entry:practice.resource.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:practice.resource.telecom:Fax.userequiredContactPointUse
Bundle.entry:practice.resource.address.userequiredAddressUse
Bundle.entry:practice.resource.address.typerequiredAddressType
Bundle.entry:practice.resource.contact.purposeextensibleContactEntityType
Bundle.entry:practice.resource.contact.name.userequiredNameUse
Bundle.entry:practice.resource.contact.telecom.systemrequiredContactPointSystem
Bundle.entry:practice.resource.contact.telecom.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:practice.resource.contact.telecom:Phone.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:practice.resource.contact.telecom:Fax.userequiredContactPointUse
Bundle.entry:practice.resource.contact.telecom:Email.systemrequiredFixed Value: email
Bundle.entry:practice.resource.contact.telecom:Email.userequiredContactPointUse
Bundle.entry:practice.search.moderequiredSearchEntryMode
Bundle.entry:practice.request.methodrequiredHTTPVerb
Bundle.entry:practitioner.search.moderequiredSearchEntryMode
Bundle.entry:practitioner.request.methodrequiredHTTPVerb
Bundle.entry:questionnaireresponse.search.moderequiredSearchEntryMode
Bundle.entry:questionnaireresponse.request.methodrequiredHTTPVerb
Bundle.entry:medicalCoverage.resource.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:medicalCoverage.resource.statusrequiredFinancialResourceStatusCodes
Bundle.entry:medicalCoverage.resource.typepreferredPattern: HIP
Bundle.entry:medicalCoverage.resource.subscriber.typeextensibleResourceType
Bundle.entry:medicalCoverage.resource.beneficiary.typeextensiblePattern: Patient
Bundle.entry:medicalCoverage.resource.relationshipextensibleSubscriberRelationshipCodes
Bundle.entry:medicalCoverage.resource.payor.typeextensiblePattern: Organization
Bundle.entry:medicalCoverage.resource.class.typeextensibleCoverageClassCodes
Bundle.entry:medicalCoverage.resource.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
Bundle.entry:medicalCoverage.resource.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes
Bundle.entry:medicalCoverage.search.moderequiredSearchEntryMode
Bundle.entry:medicalCoverage.request.methodrequiredHTTPVerb
Bundle.entry:pharmacyCoverage.resource.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:pharmacyCoverage.resource.statusrequiredFinancialResourceStatusCodes
Bundle.entry:pharmacyCoverage.resource.typepreferredPattern: DRUGPOL
Bundle.entry:pharmacyCoverage.resource.subscriber.typeextensibleResourceType
Bundle.entry:pharmacyCoverage.resource.beneficiary.typeextensiblePattern: Patient
Bundle.entry:pharmacyCoverage.resource.relationshipextensibleSubscriberRelationshipCodes
Bundle.entry:pharmacyCoverage.resource.payor.typeextensiblePattern: Organization
Bundle.entry:pharmacyCoverage.resource.class.typeextensibleCoverageClassCodes
Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.typeextensibleCoverageCopayTypeCodes
Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.exception.typeexampleExampleCoverageFinancialExceptionCodes
Bundle.entry:pharmacyCoverage.search.moderequiredSearchEntryMode
Bundle.entry:pharmacyCoverage.request.methodrequiredHTTPVerb
Bundle.entry:payer.resource.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:payer.resource.identifier.userequiredIdentifierUse
Bundle.entry:payer.resource.identifier.typeextensibleIdentifier Type Codes
Bundle.entry:payer.resource.typerequiredPattern: ins
Bundle.entry:payer.resource.telecom.systemrequiredContactPointSystem
Bundle.entry:payer.resource.telecom.userequiredContactPointUse
Bundle.entry:payer.resource.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:payer.resource.telecom:Phone.userequiredContactPointUse
Bundle.entry:payer.resource.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:payer.resource.telecom:Fax.userequiredContactPointUse
Bundle.entry:payer.resource.address.userequiredAddressUse
Bundle.entry:payer.resource.address.typerequiredAddressType
Bundle.entry:payer.resource.contact.purposeextensibleContactEntityType
Bundle.entry:payer.resource.contact.name.userequiredNameUse
Bundle.entry:payer.resource.contact.telecom.systemrequiredContactPointSystem
Bundle.entry:payer.resource.contact.telecom.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Phone.systemrequiredFixed Value: phone
Bundle.entry:payer.resource.contact.telecom:Phone.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Fax.systemrequiredFixed Value: fax
Bundle.entry:payer.resource.contact.telecom:Fax.userequiredContactPointUse
Bundle.entry:payer.resource.contact.telecom:Email.systemrequiredFixed Value: email
Bundle.entry:payer.resource.contact.telecom:Email.userequiredContactPointUse
Bundle.entry:payer.search.moderequiredSearchEntryMode
Bundle.entry:payer.request.methodrequiredHTTPVerb

This structure is derived from Bundle

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the values of type:resource, pattern:resource.ofType(Organization).type, pattern:resource.ofType(Coverage).type (Closed)

 

Other representations of profile: CSV, Excel, Schematron