Current Build

​ D.4.1 StructureDefinition: fpar-coverage

​D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/fpar/StructureDefinition/fpar-coverage

The Family Planning Annual Report Coverage Profile

This profile builds on Coverage.

This profile was published on Tue May 23 00:00:00 EDT 2017 as a draft by Healthcare Services Platform Consortium (HPSC) on behalf of FPAR.

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

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*Insurance or medical plan or a payment agreement
... primaryInsuranceClassification 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-primaryInsuranceClassification profiled by http://hl7.org/fhir/fpar/StructureDefinition/primaryInsuranceClassification
Binding: FPAR Pirmary Insurance Classification value set (required)
... dataAbsentReason 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-dataAbsentReason profiled by http://hl7.org/fhir/fpar/StructureDefinition/dataAbsentReason
Binding: http://hl7.org/fhir/fpar/CodeSystem/nullValueReason (preferred)
... identifier Σ0..*IdentifierThe primary coverage ID
... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Binding: Financial Resource Status Codes (required)
... type Σ0..1CodeableConceptType of coverage such as medical or accident
Binding: FPAR Coverage Type value set (required)
... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
... subscriber Σ0..1Reference(Patient | RelatedPerson)Subscriber to the policy
... subscriberId Σ0..1stringID assigned to the Subscriber
... beneficiary Σ0..1Reference(Patient)Plan Beneficiary
... relationship 0..1CodeableConceptBeneficiary relationship to the Subscriber
Binding: Policyholder Relationship Codes (example)
... period Σ0..1PeriodCoverage start and end dates
... payor Σ0..*Reference(Organization | Patient | RelatedPerson)Identifier for the plan or agreement issuer
... grouping 0..1BackboneElementAdditional coverage classifications
.... group Σ0..1stringAn identifier for the group
.... groupDisplay Σ0..1stringDisplay text for an identifier for the group
.... subGroup Σ0..1stringAn identifier for the subsection of the group
.... subGroupDisplay Σ0..1stringDisplay text for the subsection of the group
.... plan Σ0..1stringAn identifier for the plan
.... planDisplay Σ0..1stringDisplay text for the plan
.... subPlan Σ0..1stringAn identifier for the subsection of the plan
.... subPlanDisplay Σ0..1stringDisplay text for the subsection of the plan
.... class Σ0..1stringAn identifier for the class
.... classDisplay Σ0..1stringDisplay text for the class
.... subClass Σ0..1stringAn identifier for the subsection of the class
.... subClassDisplay Σ0..1stringDisplay text for the subsection of the subclass
... dependent Σ0..1stringDependent number
... sequence Σ0..1stringThe plan instance or sequence counter
... order Σ0..1positiveIntRelative order of the coverage
... network Σ0..1stringInsurer network
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage I0..*Insurance 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... primaryInsuranceClassification 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-primaryInsuranceClassification profiled by http://hl7.org/fhir/fpar/StructureDefinition/primaryInsuranceClassification
Binding: FPAR Pirmary Insurance Classification value set (required)
... dataAbsentReason 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-dataAbsentReason profiled by http://hl7.org/fhir/fpar/StructureDefinition/dataAbsentReason
Binding: http://hl7.org/fhir/fpar/CodeSystem/nullValueReason (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierThe primary coverage ID
... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Binding: Financial Resource Status Codes (required)
... type Σ0..1CodeableConceptType of coverage such as medical or accident
Binding: FPAR Coverage Type value set (required)
... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
... subscriber Σ0..1Reference(Patient | RelatedPerson)Subscriber to the policy
... subscriberId Σ0..1stringID assigned to the Subscriber
... beneficiary Σ0..1Reference(Patient)Plan Beneficiary
... relationship 0..1CodeableConceptBeneficiary relationship to the Subscriber
Binding: Policyholder Relationship Codes (example)
... period Σ0..1PeriodCoverage start and end dates
... payor Σ0..*Reference(Organization | Patient | RelatedPerson)Identifier for the plan or agreement issuer
... grouping I0..1BackboneElementAdditional coverage classifications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... group Σ0..1stringAn identifier for the group
.... groupDisplay Σ0..1stringDisplay text for an identifier for the group
.... subGroup Σ0..1stringAn identifier for the subsection of the group
.... subGroupDisplay Σ0..1stringDisplay text for the subsection of the group
.... plan Σ0..1stringAn identifier for the plan
.... planDisplay Σ0..1stringDisplay text for the plan
.... subPlan Σ0..1stringAn identifier for the subsection of the plan
.... subPlanDisplay Σ0..1stringDisplay text for the subsection of the plan
.... class Σ0..1stringAn identifier for the class
.... classDisplay Σ0..1stringDisplay text for the class
.... subClass Σ0..1stringAn identifier for the subsection of the class
.... subClassDisplay Σ0..1stringDisplay text for the subsection of the subclass
... dependent Σ0..1stringDependent number
... sequence Σ0..1stringThe plan instance or sequence counter
... order Σ0..1positiveIntRelative order of the coverage
... network Σ0..1stringInsurer network
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format

Differential View

This structure is derived from Coverage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage 0..*Insurance or medical plan or a payment agreement
... primaryInsuranceClassification 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-primaryInsuranceClassification profiled by http://hl7.org/fhir/fpar/StructureDefinition/primaryInsuranceClassification
Binding: FPAR Pirmary Insurance Classification value set (required)
... dataAbsentReason 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-dataAbsentReason profiled by http://hl7.org/fhir/fpar/StructureDefinition/dataAbsentReason
Binding: http://hl7.org/fhir/fpar/CodeSystem/nullValueReason (preferred)
... identifier Σ0..*IdentifierThe primary coverage ID
... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Binding: Financial Resource Status Codes (required)
... type Σ0..1CodeableConceptType of coverage such as medical or accident
Binding: FPAR Coverage Type value set (required)
... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
... subscriber Σ0..1Reference(Patient | RelatedPerson)Subscriber to the policy
... subscriberId Σ0..1stringID assigned to the Subscriber
... beneficiary Σ0..1Reference(Patient)Plan Beneficiary
... relationship 0..1CodeableConceptBeneficiary relationship to the Subscriber
Binding: Policyholder Relationship Codes (example)
... period Σ0..1PeriodCoverage start and end dates
... payor Σ0..*Reference(Organization | Patient | RelatedPerson)Identifier for the plan or agreement issuer
... grouping 0..1BackboneElementAdditional coverage classifications
.... group Σ0..1stringAn identifier for the group
.... groupDisplay Σ0..1stringDisplay text for an identifier for the group
.... subGroup Σ0..1stringAn identifier for the subsection of the group
.... subGroupDisplay Σ0..1stringDisplay text for the subsection of the group
.... plan Σ0..1stringAn identifier for the plan
.... planDisplay Σ0..1stringDisplay text for the plan
.... subPlan Σ0..1stringAn identifier for the subsection of the plan
.... subPlanDisplay Σ0..1stringDisplay text for the subsection of the plan
.... class Σ0..1stringAn identifier for the class
.... classDisplay Σ0..1stringDisplay text for the class
.... subClass Σ0..1stringAn identifier for the subsection of the class
.... subClassDisplay Σ0..1stringDisplay text for the subsection of the subclass
... dependent Σ0..1stringDependent number
... sequence Σ0..1stringThe plan instance or sequence counter
... order Σ0..1positiveIntRelative order of the coverage
... network Σ0..1stringInsurer network
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Coverage I0..*Insurance 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... primaryInsuranceClassification 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-primaryInsuranceClassification profiled by http://hl7.org/fhir/fpar/StructureDefinition/primaryInsuranceClassification
Binding: FPAR Pirmary Insurance Classification value set (required)
... dataAbsentReason 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-dataAbsentReason profiled by http://hl7.org/fhir/fpar/StructureDefinition/dataAbsentReason
Binding: http://hl7.org/fhir/fpar/CodeSystem/nullValueReason (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierThe primary coverage ID
... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Binding: Financial Resource Status Codes (required)
... type Σ0..1CodeableConceptType of coverage such as medical or accident
Binding: FPAR Coverage Type value set (required)
... policyHolder Σ0..1Reference(Patient | RelatedPerson | Organization)Owner of the policy
... subscriber Σ0..1Reference(Patient | RelatedPerson)Subscriber to the policy
... subscriberId Σ0..1stringID assigned to the Subscriber
... beneficiary Σ0..1Reference(Patient)Plan Beneficiary
... relationship 0..1CodeableConceptBeneficiary relationship to the Subscriber
Binding: Policyholder Relationship Codes (example)
... period Σ0..1PeriodCoverage start and end dates
... payor Σ0..*Reference(Organization | Patient | RelatedPerson)Identifier for the plan or agreement issuer
... grouping I0..1BackboneElementAdditional coverage classifications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... group Σ0..1stringAn identifier for the group
.... groupDisplay Σ0..1stringDisplay text for an identifier for the group
.... subGroup Σ0..1stringAn identifier for the subsection of the group
.... subGroupDisplay Σ0..1stringDisplay text for the subsection of the group
.... plan Σ0..1stringAn identifier for the plan
.... planDisplay Σ0..1stringDisplay text for the plan
.... subPlan Σ0..1stringAn identifier for the subsection of the plan
.... subPlanDisplay Σ0..1stringDisplay text for the subsection of the plan
.... class Σ0..1stringAn identifier for the class
.... classDisplay Σ0..1stringDisplay text for the class
.... subClass Σ0..1stringAn identifier for the subsection of the class
.... subClassDisplay Σ0..1stringDisplay text for the subsection of the subclass
... dependent Σ0..1stringDependent number
... sequence Σ0..1stringThe plan instance or sequence counter
... order Σ0..1positiveIntRelative order of the coverage
... network Σ0..1stringInsurer network
... contract 0..*Reference(Contract)Contract details

doco Documentation for this format

 

​D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Coverage.languageCommon LanguagesextensibleCommon Languages
Coverage.extension
[CanonicalType[http://hl7.org/fhir/fpar/StructureDefinition/primaryInsuranceClassification]]		FPAR Pirmary Insurance Classification value setrequiredFPAR Pirmary Insurance Classification value set
Coverage.extension
[CanonicalType[http://hl7.org/fhir/fpar/StructureDefinition/dataAbsentReason]]		?extpreferredhttp://hl7.org/fhir/fpar/CodeSystem/nullValueReason
Coverage.statusFinancial Resource Status CodesrequiredFinancial Resource Status Codes
Coverage.typeFPAR Coverage Type value setrequiredFPAR Coverage Type value set
Coverage.relationshipPolicyholder Relationship CodesexamplePolicyholder Relationship Codes

​D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CoverageIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1CoverageIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4CoverageIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3CoverageIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1Coverage.groupingAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.