v2+ Details
0.3.2 - Working Draft to present the concept ideas (FO)

v2+ Details - Local Development build (v0.3.2). See the Directory of published versions

Logical Model: PV2 - Detailed Descriptions

Draft as of 2023-08-09

Definitions for the PV2 logical model.

Guidance on how to interpret the contents of this table can be found here

0. PV2
Definition

Patient Visit - Additional Information

Control1..1
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. PV2.priorPendingLocation
Definition

Prior Pending Location

ShortpriorPendingLocation
Control0..1
TypePL
4. PV2.accommodationCode
Definition

Accommodation Code

ShortaccommodationCode
Control0..1
TypeCWE
6. PV2.admitReason
Definition

Admit Reason

ShortadmitReason
Control0..1
TypeCWE
8. PV2.transferReason
Definition

Transfer Reason

ShorttransferReason
Control0..1
TypeCWE
10. PV2.patientValuables
Definition

Patient Valuables

ShortpatientValuables
Control0..*
TypeST
12. PV2.patientValuablesLocation
Definition

Patient Valuables Location

ShortpatientValuablesLocation
Control0..1
TypeST
14. PV2.visitUserCode
Definition

Visit User Code

ShortvisitUserCode
Control0..*
TypeCWE
16. PV2.expectedAdmitDateTime
Definition

Expected Admit DateTime

ShortexpectedAdmitDateTime
Control0..1
TypeDTM
18. PV2.expectedDischargeDateTime
Definition

Expected Discharge DateTime

ShortexpectedDischargeDateTime
Control0..1
TypeDTM
20. PV2.estimatedLengthofInpatientStay
Definition

Estimated Length of Inpatient Stay

ShortestimatedLengthofInpatientStay
Control0..1
TypeNM
22. PV2.actualLengthofInpatientStay
Definition

Actual Length of Inpatient Stay

ShortactualLengthofInpatientStay
Control0..1
TypeNM
24. PV2.visitDescription
Definition

Visit Description

ShortvisitDescription
Control0..1
TypeST
26. PV2.referralSourceCode
Definition

Referral Source Code

ShortreferralSourceCode
Control0..*
TypeXCN
28. PV2.previousServiceDate
Definition

Previous Service Date

ShortpreviousServiceDate
Control0..1
TypeDT
30. PV2.employmentIllnessRelatedIndicator
Definition

Employment Illness Related Indicator

ShortemploymentIllnessRelatedIndicator
Control0..1
TypeID
Max Length1
32. PV2.purgeStatusCode
Definition

Purge Status Code

ShortpurgeStatusCode
Control0..1
TypeCWE
34. PV2.purgeStatusDate
Definition

Purge Status Date

ShortpurgeStatusDate
Control0..1
TypeDT
36. PV2.specialProgramCode
Definition

Special Program Code

ShortspecialProgramCode
Control0..1
TypeCWE
38. PV2.retentionIndicator
Definition

Retention Indicator

ShortretentionIndicator
Control0..1
TypeID
Max Length1
40. PV2.expectedNumberofInsurancePlans
Definition

Expected Number of Insurance Plans

ShortexpectedNumberofInsurancePlans
Control0..1
TypeNM
42. PV2.visitPublicityCode
Definition

Visit Publicity Code

ShortvisitPublicityCode
Control0..1
TypeCWE
44. PV2.visitProtectionIndicator
Definition

Visit Protection Indicator

ShortvisitProtectionIndicator
Control0..1
TypeID
Max Length1
46. PV2.clinicOrganizationName
Definition

Clinic Organization Name

ShortclinicOrganizationName
Control0..*
TypeXON
48. PV2.patientStatusCode
Definition

Patient Status Code

ShortpatientStatusCode
Control0..1
TypeCWE
50. PV2.visitPriorityCode
Definition

Visit Priority Code

ShortvisitPriorityCode
Control0..1
TypeCWE
52. PV2.previousTreatmentDate
Definition

Previous Treatment Date

ShortpreviousTreatmentDate
Control0..1
TypeDT
54. PV2.expectedDischargeDisposition
Definition

Expected Discharge Disposition

ShortexpectedDischargeDisposition
Control0..1
TypeCWE
56. PV2.signatureonFileDate
Definition

Signature on File Date

ShortsignatureonFileDate
Control0..1
TypeDT
58. PV2.firstSimilarIllnessDate
Definition

First Similar Illness Date

ShortfirstSimilarIllnessDate
Control0..1
TypeDT
60. PV2.patientChargeAdjustmentCode
Definition

Patient Charge Adjustment Code

ShortpatientChargeAdjustmentCode
Control0..1
TypeCWE
62. PV2.recurringServiceCode
Definition

Recurring Service Code

ShortrecurringServiceCode
Control0..1
TypeCWE
64. PV2.billingMediaCode
Definition

Billing Media Code

ShortbillingMediaCode
Control0..1
TypeID
Max Length1
66. PV2.expectedSurgeryDateandTime
Definition

Expected Surgery Date and Time

ShortexpectedSurgeryDateandTime
Control0..1
TypeDTM
68. PV2.militaryPartnershipCode
Definition

Military Partnership Code

ShortmilitaryPartnershipCode
Control0..1
TypeID
Max Length1
70. PV2.militaryNon-AvailabilityCode
Definition

Military Non-Availability Code

ShortmilitaryNon-AvailabilityCode
Control0..1
TypeID
Max Length1
72. PV2.newbornBabyIndicator
Definition

Newborn Baby Indicator

ShortnewbornBabyIndicator
Control0..1
TypeID
Max Length1
74. PV2.babyDetainedIndicator
Definition

Baby Detained Indicator

ShortbabyDetainedIndicator
Control0..1
TypeID
Max Length1
76. PV2.modeofArrivalCode
Definition

Mode of Arrival Code

ShortmodeofArrivalCode
Control0..1
TypeCWE
78. PV2.recreationalDrugUseCode
Definition

Recreational Drug Use Code

ShortrecreationalDrugUseCode
Control0..*
TypeCWE
80. PV2.admissionLevelofCareCode
Definition

Admission Level of Care Code

ShortadmissionLevelofCareCode
Control0..1
TypeCWE
82. PV2.precautionCode
Definition

Precaution Code

ShortprecautionCode
Control0..*
TypeCWE
84. PV2.patientConditionCode
Definition

Patient Condition Code

ShortpatientConditionCode
Control0..1
TypeCWE
86. PV2.livingWillCode
Definition

Living Will Code

ShortlivingWillCode
Control0..1
TypeCWE
88. PV2.organDonorCode
Definition

Organ Donor Code

ShortorganDonorCode
Control0..1
TypeCWE
90. PV2.advanceDirectiveCode
Definition

Advance Directive Code

ShortadvanceDirectiveCode
Control0..*
TypeCWE
92. PV2.patientStatusEffectiveDate
Definition

Patient Status Effective Date

ShortpatientStatusEffectiveDate
Control0..1
TypeDT
94. PV2.expectedLOAReturnDateTime
Definition

Expected LOA Return DateTime

ShortexpectedLOAReturnDateTime
Control0..1
TypeDTM
96. PV2.expectedPre-admissionTestingDateTime
Definition

Expected Pre-admission Testing DateTime

ShortexpectedPre-admissionTestingDateTime
Control0..1
TypeDTM
98. PV2.notifyClergyCode
Definition

Notify Clergy Code

ShortnotifyClergyCode
Control0..*
TypeCWE
100. PV2.advanceDirectiveLastVerifiedDate
Definition

Advance Directive Last Verified Date

ShortadvanceDirectiveLastVerifiedDate
Control0..1
TypeDT

Guidance on how to interpret the contents of this table can be found here

0. PV2
Definition

Patient Visit - Additional Information


A resource that includes narrative, extensions, and contained resources.

ShortA resource with narrative, extensions, and contained resources
Control10..1*
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If 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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. PV2.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. PV2.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. PV2.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PV2.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
8. PV2.priorPendingLocation
Definition

Prior Pending Location

ShortpriorPendingLocation
Control0..1
TypePL
10. PV2.accommodationCode
Definition

Accommodation Code

ShortaccommodationCode
Control0..1
TypeCWE
12. PV2.admitReason
Definition

Admit Reason

ShortadmitReason
Control0..1
TypeCWE
14. PV2.transferReason
Definition

Transfer Reason

ShorttransferReason
Control0..1
TypeCWE
16. PV2.patientValuables
Definition

Patient Valuables

ShortpatientValuables
Control0..*
TypeST
18. PV2.patientValuablesLocation
Definition

Patient Valuables Location

ShortpatientValuablesLocation
Control0..1
TypeST
20. PV2.visitUserCode
Definition

Visit User Code

ShortvisitUserCode
Control0..*
TypeCWE
22. PV2.expectedAdmitDateTime
Definition

Expected Admit DateTime

ShortexpectedAdmitDateTime
Control0..1
TypeDTM
24. PV2.expectedDischargeDateTime
Definition

Expected Discharge DateTime

ShortexpectedDischargeDateTime
Control0..1
TypeDTM
26. PV2.estimatedLengthofInpatientStay
Definition

Estimated Length of Inpatient Stay

ShortestimatedLengthofInpatientStay
Control0..1
TypeNM
28. PV2.actualLengthofInpatientStay
Definition

Actual Length of Inpatient Stay

ShortactualLengthofInpatientStay
Control0..1
TypeNM
30. PV2.visitDescription
Definition

Visit Description

ShortvisitDescription
Control0..1
TypeST
32. PV2.referralSourceCode
Definition

Referral Source Code

ShortreferralSourceCode
Control0..*
TypeXCN
34. PV2.previousServiceDate
Definition

Previous Service Date

ShortpreviousServiceDate
Control0..1
TypeDT
36. PV2.employmentIllnessRelatedIndicator
Definition

Employment Illness Related Indicator

ShortemploymentIllnessRelatedIndicator
Control0..1
TypeID
Max Length1
38. PV2.purgeStatusCode
Definition

Purge Status Code

ShortpurgeStatusCode
Control0..1
TypeCWE
40. PV2.purgeStatusDate
Definition

Purge Status Date

ShortpurgeStatusDate
Control0..1
TypeDT
42. PV2.specialProgramCode
Definition

Special Program Code

ShortspecialProgramCode
Control0..1
TypeCWE
44. PV2.retentionIndicator
Definition

Retention Indicator

ShortretentionIndicator
Control0..1
TypeID
Max Length1
46. PV2.expectedNumberofInsurancePlans
Definition

Expected Number of Insurance Plans

ShortexpectedNumberofInsurancePlans
Control0..1
TypeNM
48. PV2.visitPublicityCode
Definition

Visit Publicity Code

ShortvisitPublicityCode
Control0..1
TypeCWE
50. PV2.visitProtectionIndicator
Definition

Visit Protection Indicator

ShortvisitProtectionIndicator
Control0..1
TypeID
Max Length1
52. PV2.clinicOrganizationName
Definition

Clinic Organization Name

ShortclinicOrganizationName
Control0..*
TypeXON
54. PV2.patientStatusCode
Definition

Patient Status Code

ShortpatientStatusCode
Control0..1
TypeCWE
56. PV2.visitPriorityCode
Definition

Visit Priority Code

ShortvisitPriorityCode
Control0..1
TypeCWE
58. PV2.previousTreatmentDate
Definition

Previous Treatment Date

ShortpreviousTreatmentDate
Control0..1
TypeDT
60. PV2.expectedDischargeDisposition
Definition

Expected Discharge Disposition

ShortexpectedDischargeDisposition
Control0..1
TypeCWE
62. PV2.signatureonFileDate
Definition

Signature on File Date

ShortsignatureonFileDate
Control0..1
TypeDT
64. PV2.firstSimilarIllnessDate
Definition

First Similar Illness Date

ShortfirstSimilarIllnessDate
Control0..1
TypeDT
66. PV2.patientChargeAdjustmentCode
Definition

Patient Charge Adjustment Code

ShortpatientChargeAdjustmentCode
Control0..1
TypeCWE
68. PV2.recurringServiceCode
Definition

Recurring Service Code

ShortrecurringServiceCode
Control0..1
TypeCWE
70. PV2.billingMediaCode
Definition

Billing Media Code

ShortbillingMediaCode
Control0..1
TypeID
Max Length1
72. PV2.expectedSurgeryDateandTime
Definition

Expected Surgery Date and Time

ShortexpectedSurgeryDateandTime
Control0..1
TypeDTM
74. PV2.militaryPartnershipCode
Definition

Military Partnership Code

ShortmilitaryPartnershipCode
Control0..1
TypeID
Max Length1
76. PV2.militaryNon-AvailabilityCode
Definition

Military Non-Availability Code

ShortmilitaryNon-AvailabilityCode
Control0..1
TypeID
Max Length1
78. PV2.newbornBabyIndicator
Definition

Newborn Baby Indicator

ShortnewbornBabyIndicator
Control0..1
TypeID
Max Length1
80. PV2.babyDetainedIndicator
Definition

Baby Detained Indicator

ShortbabyDetainedIndicator
Control0..1
TypeID
Max Length1
82. PV2.modeofArrivalCode
Definition

Mode of Arrival Code

ShortmodeofArrivalCode
Control0..1
TypeCWE
84. PV2.recreationalDrugUseCode
Definition

Recreational Drug Use Code

ShortrecreationalDrugUseCode
Control0..*
TypeCWE
86. PV2.admissionLevelofCareCode
Definition

Admission Level of Care Code

ShortadmissionLevelofCareCode
Control0..1
TypeCWE
88. PV2.precautionCode
Definition

Precaution Code

ShortprecautionCode
Control0..*
TypeCWE
90. PV2.patientConditionCode
Definition

Patient Condition Code

ShortpatientConditionCode
Control0..1
TypeCWE
92. PV2.livingWillCode
Definition

Living Will Code

ShortlivingWillCode
Control0..1
TypeCWE
94. PV2.organDonorCode
Definition

Organ Donor Code

ShortorganDonorCode
Control0..1
TypeCWE
96. PV2.advanceDirectiveCode
Definition

Advance Directive Code

ShortadvanceDirectiveCode
Control0..*
TypeCWE
98. PV2.patientStatusEffectiveDate
Definition

Patient Status Effective Date

ShortpatientStatusEffectiveDate
Control0..1
TypeDT
100. PV2.expectedLOAReturnDateTime
Definition

Expected LOA Return DateTime

ShortexpectedLOAReturnDateTime
Control0..1
TypeDTM
102. PV2.expectedPre-admissionTestingDateTime
Definition

Expected Pre-admission Testing DateTime

ShortexpectedPre-admissionTestingDateTime
Control0..1
TypeDTM
104. PV2.notifyClergyCode
Definition

Notify Clergy Code

ShortnotifyClergyCode
Control0..*
TypeCWE
106. PV2.advanceDirectiveLastVerifiedDate
Definition

Advance Directive Last Verified Date

ShortadvanceDirectiveLastVerifiedDate
Control0..1
TypeDT

Guidance on how to interpret the contents of this table can be found here

0. PV2
Definition

Patient Visit - Additional Information

ShortA resource with narrative, extensions, and contained resources
Control1..1
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If 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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. PV2.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. PV2.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. PV2.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. PV2.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguages: IETF language tag for a human language
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. PV2.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. PV2.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. PV2.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PV2.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
16. PV2.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PV2.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
18. PV2.priorPendingLocation
Definition

Prior Pending Location

ShortpriorPendingLocation
Control0..1
TypePL
20. PV2.accommodationCode
Definition

Accommodation Code

ShortaccommodationCode
Control0..1
TypeCWE
22. PV2.admitReason
Definition

Admit Reason

ShortadmitReason
Control0..1
TypeCWE
24. PV2.transferReason
Definition

Transfer Reason

ShorttransferReason
Control0..1
TypeCWE
26. PV2.patientValuables
Definition

Patient Valuables

ShortpatientValuables
Control0..*
TypeST
28. PV2.patientValuablesLocation
Definition

Patient Valuables Location

ShortpatientValuablesLocation
Control0..1
TypeST
30. PV2.visitUserCode
Definition

Visit User Code

ShortvisitUserCode
Control0..*
TypeCWE
32. PV2.expectedAdmitDateTime
Definition

Expected Admit DateTime

ShortexpectedAdmitDateTime
Control0..1
TypeDTM
34. PV2.expectedDischargeDateTime
Definition

Expected Discharge DateTime

ShortexpectedDischargeDateTime
Control0..1
TypeDTM
36. PV2.estimatedLengthofInpatientStay
Definition

Estimated Length of Inpatient Stay

ShortestimatedLengthofInpatientStay
Control0..1
TypeNM
38. PV2.actualLengthofInpatientStay
Definition

Actual Length of Inpatient Stay

ShortactualLengthofInpatientStay
Control0..1
TypeNM
40. PV2.visitDescription
Definition

Visit Description

ShortvisitDescription
Control0..1
TypeST
42. PV2.referralSourceCode
Definition

Referral Source Code

ShortreferralSourceCode
Control0..*
TypeXCN
44. PV2.previousServiceDate
Definition

Previous Service Date

ShortpreviousServiceDate
Control0..1
TypeDT
46. PV2.employmentIllnessRelatedIndicator
Definition

Employment Illness Related Indicator

ShortemploymentIllnessRelatedIndicator
Control0..1
TypeID
Max Length1
48. PV2.purgeStatusCode
Definition

Purge Status Code

ShortpurgeStatusCode
Control0..1
TypeCWE
50. PV2.purgeStatusDate
Definition

Purge Status Date

ShortpurgeStatusDate
Control0..1
TypeDT
52. PV2.specialProgramCode
Definition

Special Program Code

ShortspecialProgramCode
Control0..1
TypeCWE
54. PV2.retentionIndicator
Definition

Retention Indicator

ShortretentionIndicator
Control0..1
TypeID
Max Length1
56. PV2.expectedNumberofInsurancePlans
Definition

Expected Number of Insurance Plans

ShortexpectedNumberofInsurancePlans
Control0..1
TypeNM
58. PV2.visitPublicityCode
Definition

Visit Publicity Code

ShortvisitPublicityCode
Control0..1
TypeCWE
60. PV2.visitProtectionIndicator
Definition

Visit Protection Indicator

ShortvisitProtectionIndicator
Control0..1
TypeID
Max Length1
62. PV2.clinicOrganizationName
Definition

Clinic Organization Name

ShortclinicOrganizationName
Control0..*
TypeXON
64. PV2.patientStatusCode
Definition

Patient Status Code

ShortpatientStatusCode
Control0..1
TypeCWE
66. PV2.visitPriorityCode
Definition

Visit Priority Code

ShortvisitPriorityCode
Control0..1
TypeCWE
68. PV2.previousTreatmentDate
Definition

Previous Treatment Date

ShortpreviousTreatmentDate
Control0..1
TypeDT
70. PV2.expectedDischargeDisposition
Definition

Expected Discharge Disposition

ShortexpectedDischargeDisposition
Control0..1
TypeCWE
72. PV2.signatureonFileDate
Definition

Signature on File Date

ShortsignatureonFileDate
Control0..1
TypeDT
74. PV2.firstSimilarIllnessDate
Definition

First Similar Illness Date

ShortfirstSimilarIllnessDate
Control0..1
TypeDT
76. PV2.patientChargeAdjustmentCode
Definition

Patient Charge Adjustment Code

ShortpatientChargeAdjustmentCode
Control0..1
TypeCWE
78. PV2.recurringServiceCode
Definition

Recurring Service Code

ShortrecurringServiceCode
Control0..1
TypeCWE
80. PV2.billingMediaCode
Definition

Billing Media Code

ShortbillingMediaCode
Control0..1
TypeID
Max Length1
82. PV2.expectedSurgeryDateandTime
Definition

Expected Surgery Date and Time

ShortexpectedSurgeryDateandTime
Control0..1
TypeDTM
84. PV2.militaryPartnershipCode
Definition

Military Partnership Code

ShortmilitaryPartnershipCode
Control0..1
TypeID
Max Length1
86. PV2.militaryNon-AvailabilityCode
Definition

Military Non-Availability Code

ShortmilitaryNon-AvailabilityCode
Control0..1
TypeID
Max Length1
88. PV2.newbornBabyIndicator
Definition

Newborn Baby Indicator

ShortnewbornBabyIndicator
Control0..1
TypeID
Max Length1
90. PV2.babyDetainedIndicator
Definition

Baby Detained Indicator

ShortbabyDetainedIndicator
Control0..1
TypeID
Max Length1
92. PV2.modeofArrivalCode
Definition

Mode of Arrival Code

ShortmodeofArrivalCode
Control0..1
TypeCWE
94. PV2.recreationalDrugUseCode
Definition

Recreational Drug Use Code

ShortrecreationalDrugUseCode
Control0..*
TypeCWE
96. PV2.admissionLevelofCareCode
Definition

Admission Level of Care Code

ShortadmissionLevelofCareCode
Control0..1
TypeCWE
98. PV2.precautionCode
Definition

Precaution Code

ShortprecautionCode
Control0..*
TypeCWE
100. PV2.patientConditionCode
Definition

Patient Condition Code

ShortpatientConditionCode
Control0..1
TypeCWE
102. PV2.livingWillCode
Definition

Living Will Code

ShortlivingWillCode
Control0..1
TypeCWE
104. PV2.organDonorCode
Definition

Organ Donor Code

ShortorganDonorCode
Control0..1
TypeCWE
106. PV2.advanceDirectiveCode
Definition

Advance Directive Code

ShortadvanceDirectiveCode
Control0..*
TypeCWE
108. PV2.patientStatusEffectiveDate
Definition

Patient Status Effective Date

ShortpatientStatusEffectiveDate
Control0..1
TypeDT
110. PV2.expectedLOAReturnDateTime
Definition

Expected LOA Return DateTime

ShortexpectedLOAReturnDateTime
Control0..1
TypeDTM
112. PV2.expectedPre-admissionTestingDateTime
Definition

Expected Pre-admission Testing DateTime

ShortexpectedPre-admissionTestingDateTime
Control0..1
TypeDTM
114. PV2.notifyClergyCode
Definition

Notify Clergy Code

ShortnotifyClergyCode
Control0..*
TypeCWE
116. PV2.advanceDirectiveLastVerifiedDate
Definition

Advance Directive Last Verified Date

ShortadvanceDirectiveLastVerifiedDate
Control0..1
TypeDT