:

  1. Welcome
  2. userguide
  3. 4.01 Artifact Contribution Frequently Asked Questions (FAQs)

4.01 Artifact Contribution Frequently Asked Questions (FAQs)

Artifact Contribution Frequently Asked Questions

What is the overall process to contribute a CDS artifact to the Repository?

First, you must obtain a CDS Connect user account with Repository Contributor permissions. Once your account is set up, you should:

  1. Contact the CDS Connect project team on expected data, formats, and your anticipated timeline by emailing the team: cds-connect-feedback-list@groups.mitre.org.
  2. Set up Author and Group credentials with the CDS Connect project team.
  3. Familiarize yourself with the artifact data fields.
  4. Confirm with the CDS Connect project team the Status or Experimental status of your artifact.
  5. Author your artifact. If needed, request the CDS Connect project team add new entries in the metadata database to support your use case.
  6. Submit the artifact to the CDS Connect team for review.
  7. Address review feedback with modifications or explanations in your artifact, as needed.
  8. Alert the CDS Connect project team you are ready to publish the content.

In addition to this user guide, you can find documentation on how to use the Repository account in the July 2018 work group slides.

Are there any demonstrations of how to author an artifact?

For an overview of CDS Connect, how the CDS Connect Repository fits into the CDS Connect lifecycle, and how to author an artifact, watch the ONC Tech Forum: Clinical Decision Support Series Session #2, recorded in September 2023.

For the start of the artifact creation process in the CDS Connect Repository, please see the segment beginning at the 40:57 timestamp. 

What information is required to add my artifact to the Repository?

Each artifact is described by 48 data fields distributed across the 11 tabs of the “Create Artifact” form.

Only four of these fields (Name, Version, Status, Artifact Type) are required to begin your entry.  The additional information you add to complete the description and content of your artifact will depend on the characteristics and knowledge level of your artifact.

All data fields, organized by the tab on which they appear in the artifact authoring screens, are listed below. The four required fields are denoted with an asterisk.

  • Primary Content
    • Name*
    • Description
  • Metadata
    • Unique Identifier
    • Version*
    • Status*
    • Experimental Status
    • Artifact Type*
    • Creation Date
  • Artifact Creation and Usage
    • License
    • Copyrights
    • Keywords
    • Steward
    • Publisher
    • Contributors
    • IP Attestation Flag
  • Artifact Organization
    • MeSH Topics
    • Knowledge Level
    • Related Artifacts
  • Artifact Representation
    • Triggers
    • Inclusions
    • Exclusions
    • Interventions and Actions
    • Logic Files
  • Implementation Details
    • Engineering Details
    • Technical Files
    • Miscellaneous Files
  • Purpose and Usage
    • Purpose
    • Intended Population
    • Usage
    • Cautions
    • Test Patients
  • Supporting Evidence
    • Source Description
    • Sources
    • References
    • Recommendation Statement
      • Strength of Recommendation
      • Quality of Evidence
      • Decision Notes
    • Artifact Decision Notes
  • Repository Information
    • Approval Date
    • Expiration Date
    • Last Review Date
    • Publication Date
    • Preview Image
  • Testing Experience
    • Pilot Experience
  • CRD (coverage requirements discovery)
    • Payer
    • Code System
    • Electronic Prescribing Code

What are row weights and why do I use them with keywords, stewards, publisher, MeSH Topics, and related artifacts when authoring an artifact?

Row weights is a feature that allows you to re-order how items in a list are displayed. While editing artifact metadata fields, you can assign a higher priority number to the item you'd like to appear at the top of a list. For example, an item assigned a "1" will appear higher on the list than an item assigned a "10".

What are the technical requirements for uploading Logic files?

Files uploaded to CDS Connect must meet the following technical requirements:

  • Unlimited number of files can be uploaded to this field.
  • 20 MB limit.
  • Allowed types: .TXT, .HTML, .CQL, .JSON, .ZIP.

What are the technical requirements for uploading Technical Files?

  • Unlimited number of files can be uploaded to this field.
  • 20 MB limit.
  • Allowed types: .TXT, .DOC, .DOCX, .XLS, .XLSX, .ZIP, .JSON, .PDF, .HTML, .HTM, .XML.

Are there other requirements I need to be aware of when uploading files to CDS Connect?

Please see 508 requirement information listed in the website FAQ  "How do I maintain my contributed CDS artifacts?"