Uploaded image for project: 'FHIR Specification Feedback'
  1. FHIR Specification Feedback
  2. FHIR-36039

Multiple changes to RelatedArtifactType value set

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • R5
    • Modeling & Methodology
    • MetadataResource
    • Hide
      • 1. Change definition of “supported-with” to “The target artifact contains additional information related to the knowledge artifact but is not documentation as the additional information does not describe, explain, or instruct regarding the knowledge artifact content or application. This could include an associated dataset.”
      • 2. Add code “documents” with display “Documents” and definition “This artifact provides additional documentation for the target artifact. This could include additional instructions on usage as well as additional information on clinical context or appropriateness.”
      • 3. Change definition of “supports” to “This artifact provides additional support for the target artifact. The type of support  is not documentation as it does not describe, explain, or instruct regarding the target artifact.”
      • 4. Deprecate the code “citation” and its display and definition
      • 5. Add code “specification-of” with display “Specification of” and definition “The target artifact is a precise description of a concept in this artifact. This may be used when the RelatedArtifact datatype is used in elements contained in this artifact.”
      • 6. Change definition of “predecessor” to “The previous version of the knowledge artifact, used to establish an ordering of versions of an artifact, independent of the status of each version.”
      • 7. Change definition of “successor” to “The subsequent version of the knowledge artfact, used to establish an ordering of versions of an artifact, independent of the status of each version.”
      • 8. Change definition of “depends-on” to “This artifact depends on the target artifact. There is a requirement to use the target artifact in the implementation or interpretation of this artifact.”
      • 9. Add code “created-with” with display “Created With” and definition “This artifact was created with the target artifact. The target artifact is a tool or support material used in the creation of the artifact, and not content that the artifact was derived from.”
      • 10. Add code "cite-as" with display “Citation for” and a definition of "The related artifact is the citation for this artifact."

      Add in the following from the comments:
      1) Define a subset of codes that are allowed to be used when the RelatedArtifact is referencing a FHIR resource
      2) Define an invariant that ensures that only that subset is used when the RelatedArtifact is referencing a FHIR resource
      3) Make sure that RelatedArtifact is documented for use only with definitional resources

      Show
      1. Change definition of “supported-with” to “The target artifact contains additional information related to the knowledge artifact but is not documentation as the additional information does not describe, explain, or instruct regarding the knowledge artifact content or application. This could include an associated dataset.” 2. Add code “documents” with display “Documents” and definition “This artifact provides additional documentation for the target artifact. This could include additional instructions on usage as well as additional information on clinical context or appropriateness.” 3. Change definition of “supports” to “This artifact provides additional support for the target artifact. The type of support  is not documentation as it does not describe, explain, or instruct regarding the target artifact.” 4. Deprecate the code “citation” and its display and definition 5. Add code “specification-of” with display “Specification of” and definition “The target artifact is a precise description of a concept in this artifact. This may be used when the RelatedArtifact datatype is used in elements contained in this artifact.” 6. Change definition of “predecessor” to “The previous version of the knowledge artifact, used to establish an ordering of versions of an artifact, independent of the status of each version.” 7. Change definition of “successor” to “The subsequent version of the knowledge artfact, used to establish an ordering of versions of an artifact, independent of the status of each version.” 8. Change definition of “depends-on” to “This artifact depends on the target artifact. There is a requirement to use the target artifact in the implementation or interpretation of this artifact.” 9. Add code “created-with” with display “Created With” and definition “This artifact was created with the target artifact. The target artifact is a tool or support material used in the creation of the artifact, and not content that the artifact was derived from.” 10. Add code "cite-as" with display “Citation for” and a definition of "The related artifact is the citation for this artifact." Add in the following from the comments: 1) Define a subset of codes that are allowed to be used when the RelatedArtifact is referencing a FHIR resource 2) Define an invariant that ensures that only that subset is used when the RelatedArtifact is referencing a FHIR resource 3) Make sure that RelatedArtifact is documented for use only with definitional resources
    • Lloyd McKenzie / Brian Alper : 4-0-0
    • Enhancement
    • Compatible, substantive
    • R5

    Description

      Multiple efforts using the RelatedArtifact Datatype have demonstrated the need for changes to the required value set used for RelatedArtifactType specification.  These efforts have included mapping ClinicalTrials.gov registry data to FHIR, mapping MEDLINE citations to FHIR, mapping scientific evidence results to FHIR, and mapping crosswalks of common metadata elements in 20 different standards and schemas used in data exchange for research data.   Details are summarized in brief at https://docs.google.com/document/d/1rJWPq8Ga9qlwsDFGY0V0cAV6l5PAXQ5TyzAVUSCsgy0

       

      The resulting 10 changes are:

      • 1. Change definition of “supported-with” to “The target artifact contains additional information related to the knowledge resource but is not documentation as the additional information does not describe, explain, or instruct regarding the knowledge resource content or application. This could include an associated dataset.”
      • 2. Add code “documents” with display “Documents” and definition “This artifact provides additional documentation for the target artifact. This could include additional instructions on usage as well as additional information on clinical context or appropriateness.”
      • 3. Change definition of “supports” to “This artifact provides additional support for the target artifact. The type of support  is not documentation as it does not describe, explain, or instruct regarding the target artifact.”
      • 4. Remove/deprecate the code “citation” and its display and definition
      • 5. Add code “specification-of” with display “Specification of” and definition “The target artifact is a precise description of a concept in this artifact. This may be used when the RelatedArtifact datatype is used in elements contained in this artifact.”
      • 6. Change definition of “predecessor” to “A previous version of the knowledge resource.”
      • 7. Change definition of “successor” to “A subsequent version of the knowledge resource.”
      • 8. Change definition of “depends-on” to “This artifact depends on the target artifact. There is a requirement to use the target artifact in the implementation or interpretation of this artifact.”
      • 9. Add code “created-with” with display “Created With” and definition “This artifact was created with the target artifact. The target artifact is a tool or support material used in the creation of the artifact, and not content that the artifact was derived from.”
      • 10. Add code "cite-as" with display “Citation for” and a definition of "The related artifact is the citation (i.e. Citation resource) for this resource" – noted in FHIR-34336

      Attachments

        Activity

          People

            bryn.rhodes Bryn Rhodes
            balper Brian S. Alper
            Brian S. Alper, Joanne Dehnbostel
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: