NextGen Knowledge Center

Available Agent Options for CCD Export except Locked Encounters

For CCD/Personal Health Record (PHR) generation select one or more of the following as applicable.

CategoryOptionValue
CDA Export
 CDA Content Selection FilterUse to exclude information, such as Advanced Directives, Allergies, Lab Results, and so on, and related section information from a CDA document. For example, if you exclude resolved allergies, they are not included in the document, but unresolved allergies are. To configure the filter,
  • Select the Ellipsis button.
  • Clear the items you want to exclude, and select OK.

If you use both CDA Content Selection Filter option and the Content Generation Filter option, then the effects of the filters combine. That is, a category is omitted from CDAs if it is excluded by either filter.

Of these two filters, the Content Generation Filter has the advantage of lowering agent overhead, because it limits the information collection by the agents. By contrast, the CDA Content Selection Filter specifies what portion of the collected information is exported. The other difference between these options is that they present slightly different categories of information for filtering.

<add key="CDA_Content_Selection_Filter" value="{[AdvanceDirectives]}{[Allergies]}{[IncludeResolvedAllergies]}{[Assessment]}{[CareTeams]}{[ChiefComplaintAndReasonForVisit]}{[ClinicalNotes]}{[ConsultNote]}{[DischargeSummaryNote]}{[HistoryPhysicalNote]}{[ImagingNarrativeNote]}{[LaboratoryReportNarrativeNote]}{[PathologyReportNarrativeNote]}{[ProcedureNote]}{[ProgressNote]}{[Diagnoses]}{[Encounters]}{[EncounterCareTeamMembers]}{[FamilyHistory]}{[FunctionalStatus]}{[Goals]}{[HealthConcern]}{[HealthStatusEvaluation]}{[HistoryOfPresentIllness]}{[Immunizations]}{[Instructions]}{[Interventions]}{[LabResults]}{[IncludeUnverifiedLabResults]}{[MedicalEquipment]}{[Medications]}{[IncludeInactiveMedications]}{[PayerInformation]}{[PlanOfCare]}{[Problems]}{[IncludePatientDiagnosis]}{[Procedures]}{[IncludeTobaccoScreening]}{[IncludeSnomedProcedures]}{[ReasonForReferral]}{[SocialHistory]}{[VitalSigns]}" />

CDA Validation
 Enable CDA ValidationIf this option is made available, the agent attempts to validate the CDA document.

<add key="CDA_Validation_Enable" value="Yes" />

 On Validator Error – Cancel ExportIf this option is made available, the agent does not export the CDA if validation could not be performed.

<add key="CDA_Validation_Export_OnValidatorError_Cancel_Export" value="No" />

 On Validation Failure – Cancel ExportIf this option is made available, the agent does not export the CDA if there are validation errors.

key="CDA_Validation_Export_OnValidationFail_Cancel_Export" value="No" />

Consent
 Process patient's Health Information Exchange (HIE) consentSet to Yes to process the patient's HIE consent. The default value is No.

<add key="Process_HIE_Consent" value="No" />

Content Filter
 CDA Content Date LimitSpecify the maximum number of days of the CDA content to be collected for a patient. Possible values are:
  • NoLimit: No limit (the default value)
  • 91: Three months
  • 182: Six months
  • 365: One year
  • 547: 18 months
  • 730: Two years
  • 1095: Three years
  • 1826: Five years

<add key="CDA_Content_Date_Limit" value="{[NoLimit]}" />

Cross References
 Continue exporting even when no cross reference internal values presentWhen this option is made available, the agent continues exporting even if the values of any cross reference items are not present in the database. The default value is No.

<add key="Continue_Exporting_When_No_Cross_Reference_Internal_Values_Present" value="No" />

 Provider ID OptionSelect one of the following options to determine how the Provider ID is handled:
  • External Provider ID: Not currently supported
  • National Provider ID: Uses the National Provider ID
  • UPIN: Not currently supported
  • Provider GUID: Uses the NextGen Provider ID (the default value)
  • Ignore: Ignores the value

<add key="Provider_ID_Option" value="{[Provider GUID]}" />

Demographics
 Gender Export ValueSpecifies whether to use birth sex or current gender to fill the administrative gender field. Following are the possible values and their meanings:
  • Current Gender: Export the current gender.
  • Birth Sex: Export the birth sex.
  • Current Gender Then Birth Sex: Export the current gender; if not found, export the birth sex.
  • Birth Sex Then Current Gender: Export the birth sex; if not found, export the current gender.

The default value is Current Gender.

<add key="Gender_Export_Value" value="{[Current Gender]}" />

Events
 Continuity of Care Document (HITSP C32 version 2.5) ExportSet to Yes to queue the requested CCD for export.

<add key="HITSPC32V25" value="No" />

Export
 Allow export of Duplicate CCDsSet to Yes to export duplicate CCDs.

<add key="Allow_Duplicate_CCD" value="No" />

 Automatically Include Sensitive Encounter InformationWhen set to Yes, the agent includes data regardless of the data being from sensitive encounters. When set to No, the system uses the Use Portal Sensitive Encounter Indicator agent option to determine the sensitive encounters to be exported.

The default value of Automatically Include Sensitive Encounter Information is No.

This option does not affect exports from the Data Share module, Medical Summary Utility, or the Referral Orders template in NextGen® Enterprise EHR.

The system prevents you from setting the Automatically Include Sensitive Encounter Information option and the Use Portal Sensitive Encounter Indicator option to Yes at the same time.

<add key="Automatically_Include_Sensitive_Encounter_Information" value="No" />

 Confidentiality Code SourceThis option provides a way to preserve the behavior of the deimplemented Read Confidentiality Code From CDA option. You can select one of the following values:
  • Read Confidentiality Code From CCD: Behave as if the old Read Confidentiality Code From CDA agent option is set to Yes.
  • Use Custom Confidentiality Code: Use the confidentiality code specified by the Select Confidentiality Code Option agent option.
  • Default Behavior: Behave as if the old Read Confidentiality Code From CDA agent option is set to No.

<add key="Confidentiality_Code_Source" value="{[dftl]}" />

 Content Generation FilterUse to exclude information, such as advanced directives, allergies, lab results, and so on, from a CDA document. For example if you exclude lab results, the results are not included in the document, but the section is, therefore enabling Consolidated Clinical Data Architecture (C-CDA) validation. However, excluding information can invalidate Meaningful Use requirements. To configure this filter,
  • In the Agent Options section, expand Export, and select the Ellipsis button.
  • Clear the items you want to exclude and then select OK.

For further information, refer to the CDA Content Selection Filter option mentioned earlier.

<add key="Content_Generation_Filter" value="{[AdvanceDirectives]}{[Allergies]}{[Assessment]}{[CareTeams]}{[ClinicalNotes]}{[ConsultNote]}{[DischargeSummaryNote]}{[HistoryPhysicalNote]}{[ImagingNarrativeNote]}{[LaboratoryReportNarrativeNote]}{[PathologyReportNarrativeNote]}{[ProcedureNote]}{[ProgressNote]}{[Demographics]}{[Balances]}{[NextOfKin]}{[BirthHistory]}{[Diagnoses]}{[Encounters]}{[EncounterCareTeamMembers]}{[FamilyHistory]}{[FunctionalStatus]}{[HealthConcern]}{[HistoryOfPresentIllness]}{[Immunizations]}{[Instructions]}{[LabResults]}{[MedicalEquipment]}{[Medications]}{[MentalStatus]}{[PayerInformation]}{[PlanOfCare]}{[Problems]}{[IncludeResolvedProblems]}{[IncludeActiveChronicProblems]}{[IncludeActiveAcuteProblems]}{[Procedures]}{[SocialHistory]}{[VitalSigns]}" />

 Deprecate previous exported CCDSet to Yes to deprecate previously exported CCDs.

<add key="Deprecate_CCD" value="Yes" />

 Document Convert to FormatSpecify whether to convert documents to attachments in one of the following formats:
  • NoConversion: No conversion.
  • PDF: Convert RTF or Word to PDF format.
  • RTF: Convert document to RTF format.
  • DOCX: Convert document to DOCX format.
  • TIFF: Convert document to TIFF format.

<add key="Document_Convert_Format" value="{[NoConversion]}" />

 Document Level Confidentiality CodeSpecifies the level of confidentiality for the document:
  • N:Normal
  • R:Restricted
  • V:Very Restricted

The default value is N.

<add key="Document_Level_Confidentiality_Code" value="{[Normal]}" />

 Do Not Encode AmpersandIf selectedYes, prevents the & (ampersand) character from being encoded as &amp; when the ampersand is used as part of a code for another character, such as &#39; (single quote) or &#34; (double quote). The default value is No.

<add key="Do_Not_Encode_Ampersand" value="Yes" />

 Enterprises For ExportIf needed, select specific enterprises that export data. If none are selected, all are exported.

<add key="Enterprise_To_Send" value="" />

 Export External PersonSpecify whether to prevent the export of CCDs that lack an external ID for a person.
  • Yes: Skip exporting any CCDs for persons that lack an external ID.
  • No: Export CCDs even if they lack an external ID for a person. This value is the default.

<add key="Enterprise_To_Send" value="" />

 Export IMO CodesSpecify whether to include Intelligent Medical Objects (IMO) concept codes when exporting C-CDAs. The default value is Yes.

<add key="Export_IMO_Code" value="Yes" />

 Generate New GUID for CDA Document ID ExtensionIf Yes, sets the id root and extension in the C-CDA document to a unique value that does not match the XDSDocumentEntry.uniqueID value in the SOAP envelope.

If No, sets the id root and extension in the C-CDA document so they match the XDSDocumentEntry.uniqueID value in the SOAP envelope. In this case, the XDSDocumentEntry.uniqueID value is compounded of the id root value, followed by a carat (^), followed by the extension value.

<add key="Doc_Ext_As_Guid" value="Yes" />

 Image Convert to FormatTo include images as PDF attachments when generating CCDs, select PDF.

<add key="Image_Convert_Format" value="{[NoConversion]}" />

 Include clinical context when collecting encounter-level CCD informationThis option is replaced by the Information to include/exclude for clinical context option, which provides more detailed control over clinical context information.
 Include email in CCD DocumentsThis option can include or exclude a provider’s email in the Author section of a CCD. The default value is Yes to include the email.

<add key="Include_Email_In_CCD" value="Yes" />

 Include Inactive ProviderIncludes the information for the inactive providers.

<add key="Include_Inactive_Provider" value="No" />

 Include Legacy Template IdsSpecifies whether to include legacy template IDs in addition to the current template IDs. The default value is No.

<add key="Include_Legacy_Template_Ids" value="No" />

 Include Provenance AtSpecifies the level at which provenance should be included in the document:
  • Document Level: Include Provenance information only at document level.
  • Document and Entry Level: Include Provenance information at both document and at entry level. This is the default value.

<add key="Include_Provenance_At" value="{[Document and Entry Level]}" />

 Information to include/exclude for clinical contextSpecifies which types of clinical information to include when creating an encounter-level CCD.
You can set the value as follows:
  • Default value: "{[Diagnoses]}{[Medications]}{[Allergies]}{[Immunizations]}{[PlanOfCare]}{[Problems]}{[MedicalEquipment]}"
  • Permitted value: "{[Diagnoses]}{[Medications]}{[Allergies]}{[Immunizations]}{[PlanOfCare]}{[Problems]}{[MedicalEquipment]}{[PastMedicalHistory]}"

<add key="Information_To_Include_For_Clinical_Context" value="{[Diagnoses]}{[Medications]}{[Allergies]}{[Immunizations]}{[PlanOfCare]}{[Problems]}{[MedicalEquipment]}" />

 Legal Authenticator - Designated User IdSpecifies the user ID of the legal authenticator to be used when the Legal Authenticator Selection agent option is set to Designated User Id. If another Legal Authenticator Selection value is selected, this option is ignored.

<add key="Designated_User_Id_For_LA" value="" />

 Legal Authenticator SelectionSpecifies which user should be listed as the legal authenticator in an exported C-CDA.
  • Intrf_queue User: The user specified by the intrf_queue.created_by database field. This is the user responsible for triggering the generation of the C-CDA (for example, the active user in NextGen® Enterprise EHR, the user who locks the encounter when there is an Encounter Lock trigger, or the system user for some automated generation scenarios).
  • Designated User Id: The user specified by the Legal Authenticator- Designated User Id agent option. The selected user must be a person, not a system user.
  • Supervising Provider then Rendering Provider: The supervising provider for the encounter (if any), otherwise the rendering provider for the encounter. If neither of these exist, and the C-CDA is longitudinal, then the user is taken from the latest encounter that has a rendering provider; the supervising provider is used if available, otherwise, the rendering provider is used.
  • Rendering Provider: The rendering provider for the encounter, or if none is present, then the rendering provider for the latest encounter that has a rendering provider. If no encounters have a rendering provider, then no legal authenticator is included in the C-CDA.
  • On Behalf Of Provider/Active Provider: The On Behalf Of provider in Medical Summary Utility or the currently selected provider in NextGen® Enterprise EHR. Do not select this value for agents that support automated C-CDA generation. If this value is selected, no Legal Authenticator is included in automatically generated C-CDAs.
  • Intrf_queue Provider: The provider in the intrf_queue.provider_id field (if any). This is the provider associated with the generated C-CDA (for example, the rendering provider if one and only one encounter is selected in the Clinical Information section in the Data Share module or the Medical Summary Utility). The value may be empty if multiple encounters are selected.

    If no provider is present in the intrf_queue.provider_id field, then no Legal Authenticator is included in the C-CDA.

  • No Legal Authenticator: No Legal Authenticator is included in the C-CDA.

The default value is Intrf_queue User.

<add key="Legal_Authenticator" value="{[Intrf_queue User]}" />

 Location For Sensitive Data WarningSpecifies when to include the sensitive warning message in the document. Select one of the following:
  • AlwaysIncludeAtSectionLevel: Includes the sensitive warning message at the section level in all documents, irrespective the sensitive data is removed or not.
  • SectionLevel: Includes the sensitive warning message at the section level when sensitive data is removed from the section.
  • DoNotSendWarning: Does not include the sensitive warning message in the document. The document has no indication that sensitive data might be removed.

The default value is SectionLevel.

The sensitive warning message is specified by the Sensitive Warning Message agent option.

<add key="Sensitive_Warning_Message_Location" value="{[SectionLevel]}" />

 Locations For ExportIf needed, select specific locations to export data. If none are selected, all are exported.
 Maximum Export Records Per CycleSet to 100. Setting a lower value can cause a performance degradation when exporting longitudinal CCDs. If you want to limit the number of items in each exported file, use the Transport > Number of Items Per Fileoption instead.

<add key="Max_Export_Records_Per_Cycle" value="100" />

 Maximum Previous Addresses For ExportThe maximum number of previous addresses to include for each export. If there are more previous addresses than the maximum, then the oldest addresses are omitted. The default value is 9999. If the value is 0, then no previous addresses are included.

<add key="Max_Pre_Address_Records_For_Export" value="9999" />

 Practices For ExportIf needed, select specific practices to export data. If none are selected, all are exported.

<add key="Practice_To_Send" value="" />

 Read Confidentiality Code From CDAThis option is replaced by the Select Confidentiality Code Option option.

Formerly, this option could export a confidentiality code that is set in a generated CDA document and used for submission. If the value is Yes, a code of Normal Sharing is set. The default value is No, which means that no confidentiality code is set.

To preserve the behavior of this deprecated option, you can use the Confidentiality Code Source option instead.

<add key="Confidentiality_Code_Source" value="{[dftl]}" />

 Select Confidentiality CodeSelect one of the following:
  • No Sharing: Not to be imported from or exported to an external system under any circumstances.
  • Normal: Only authorized individuals with a legitimate or medical business may access this item.
  • Restricted: Only providers having a current care relationship to the patient can access this item.
  • Sensitive Sharing: Information which the patient seeks heightened confidentiality, and which is not to be shared with family members.
  • Default behaviour: Same as Normal.

You can change the list of available values for this option by editing the XDS Confidentiality master list in File Maintenance.

<add key="Confidentiality_Code_Options" value="" />

 Sensitive Warning MessageSpecifies the warning message to be added to the document when sensitive information is excluded. The default value is 'As per patient privacy policy, some of the clinical information may not be visible'. You can enter a string of any text.

The Location For Sensitive Data Warning agent option specifies where and when this message is included in documents.

<add key="Sensitive_Warning_Message" value="As per patient privacy policy some of the clinical information may not be visible." />

 Tobacco ProceduresUse this option to specify tobacco procedures. Values of this option are from the 2016 Tobacco measure.
  • 11366-2: History of tobacco use Narrative
  • 39240-7: Tobacco use [CPHS]
  • 68535-4: Have you used tobacco in the last 30 days [SAMHSA]
  • 68536-2: Have you used smokeless tobacco product in the last 30 days [SAMHSA]
  • 72166-2: Tobacco smoking status [NHIS]

<add key="Tobacco_Procedures" value="{[68535-4= Have you used tobacco in the last 30 days [SAMHSA]]}{[39240-7= Tobacco use CPHS]}{[11366-2= History of tobacco use Narrative]}{[68536-2= Have you used smokeless tobacco product in the last 30 days [SAMHSA]}{[72166-2= Tobacco smoking status NHIS]}" />

 Use Portal Sensitive Encounter IndicatorWorks together with the Automatically Include Sensitive Encounter Information option to specify which type of sensitive encounters are suppressed.
When Automatically Include Sensitive Encounter Information is No, the Use Portal Sensitive Encounter Indicator values have the following effects:
  • Yes: Suppresses encounters that have Sensitive Encounter and Suppress Auto Send to Patient Portal settings available in NextGen® Enterprise EHR.
  • No: Suppresses encounters that have Sensitive Encounter setting available, but Suppress Auto Send to Patient Portal setting disabled in NextGen® Enterprise EHR.

When Automatically Include Sensitive Encounter Information value is Yes the Use Portal Sensitive Encounter Indicator option has no effect. All sensitive data is exported.

The default value of Use Portal Sensitive Encounter Indicator is No.

The system prevents you from setting the Use Portal Sensitive Encounter Indicator and Automatically Include Sensitive Encounter Information options to Yes at the same time.

These options do not affect exports from the Data Share module, the Medical Summary Utility, or the Referral Orders template.

<add key="Use_Portal_Sensitive_Encounter_Indicator" value="No" />

 Send Billable EncounterYou can use the Send Billable Encounter to include or exclude encounters in the generated CCD/PHR based on the billable indicator.
  • Ignore: Ignores the billable encounter check and processes the data in C-CDA.
  • Yes: Processes the data for the encounter and shows in C-CDA if an encounter is marked billable.
  • No: Do not process the data if marked no (unchecked).

The default value is Ignore.

<add key="Export_Billable_Encounter" value="{[Ignore]}" />

 Send Clinical EncounterYou can use the Send Clinical Encounter to include or exclude encounters in the generated CCD/PHR based on the clinical indicator.
  • Ignore: Ignores the clinical encounter check and processes the clinical data in C-CDA.
  • Yes: Processes the clinical data for the encounter and shows in C-CDA if an encounter is marked clinical.
  • No: Do not process the clinical data if marked no (unchecked).

The default value is Ignore.

<add key="Export_Clinical_Encounter" value="{[Ignore]}" />

General
 Care Plan Document TypeThe specific type of Care Plan document that is exported. The default value is 18776-5, Plan of Care Note. This option has effect only when the General > Default C-CDA R2.1 Template option is set to Care Plan.

<add key="Care_Plan_Document_Type" value="{[18776-5]}" />

 Default C-CDA R2.1 TemplateSpecifies the default template to use when creating R2.1 documents. The available values are CCD, Care Plan, Referral Note, and History and Physical.

The default value is CCD. This option has effect only if the General > Format option is set to C-CDA R2.1.

<add key="Default_CCDAR21_Template" value="{[CCD]}" />

 Enable Agent Activity SerializationSpecify whether the agent should serialize and store all agent activities to the intrf_queue database table. A setting of Yes saves agent activity to conveniently run reports. However, a setting of No causes the agent to run faster. The default value is Yes.

<add key="Enable_Agent_Activity_Serialization" value="Yes" />

 External System NameSelect the name of the external system that exchanges data with.

<add key="External_System_Name" value="{[QA2]}" />

 External System To Xref Codes In Code TablesSelect the external system used to cross reference codes in Code Tables. The value must be CCDAR21 if the General > Format option is C-CDA R2.1. The default value is CCDAR21. During agent upgrades to 5.9 from earlier releases, the value is changed to CCDAR21.

<add key="Code_Tables_External_System_Name" value="{[CCDAR21]}" />

 External System To Xref Codes In Mstr ListsSelect the external system used to cross reference codes in Master Lists. The value must be CCDAR21 if the General > Format option is C-CDA R2.1. The default value is CCDAR21. During agent upgrades to 5.9 from earlier releases, the value is changed to CCDAR21.

<add key="Mstr_lists_External_System_Name" value="{[CCDAR21]}" />

 FormatSelect one of the following:
  • BPPC: Generates a BPPC consent document.
  • C-CDA: Generates a C-CDA 1.1 formatted medical summary.
  • C-CDA R2.1: Generates a C-CDA R2.1 formatted medical summary.
  • C32: Generates a HITSP C32 version 2.3 formatted medical summary.
  • C32 CDSC: Generates a C32 document according to CDSC specifications.
  • C32 v2.5: Generates a HITSP C32 version 2.5 formatted medical summary.
  • Cancer Event Report: Generates a Cancer Registry Reporting 1.0 document.
  • Cancer Event Report 1.1: Generates a Cancer Registry Reporting 1.1 document.
  • National Health Care Survey: Used only for certification. To submit survey data to the CDC, use National Health Care Survey 1.1 instead.
  • National Health Care Survey 1.1:National Health Care Survey 1.2: Generates input for the National Ambulatory Medical Care Survey (NAMCS) at the specified level (1.1 or 1.2).
  • Public Health Case Report: Generates a Public Health Case Report document.
  • XACML: Generates a XACML consent document.
  • XDSMS: Generates an IHE XDSMS formatted medical summary.

<add key="Document_Format" value="{[National Health Care Survey 1.2]}" />

 Interface User IDSelect the NextGen User ID for the interface.

<add key="Interface_User_Id" value="{[0]}" />

 NextGen Practice IdentifierSelect the Practice ID (typically 0001) .

<add key="Practice_Id" value="{[0001]}" />

 Referral Document TypeThe specific type of Referral Note document that is exported. The default value is 57133-1, Referral Note. This option has an effect only when the General > Default C-CDA R2.1 Template option is set to Referral Note.

<add key="Referral_Document_Type" value="{[57133-1]}" />

Available Agent Options for CCD Export except Locked Encounters