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

StructureDefinition suggests version is a timestamp

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • R5
    • FHIR Infrastructure
    • StructureDefinition
    • Hide

      1. Update the long definition for definitions.html#StructureDefinition.version to read:

      >The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. There is no expectation that versions can be placed in a lexicographical sequence, so authors are encouraged to populate the StructureDefinition.versionAlgorithm[x] element to enable comparisons. If there is no managed version available, authors can consider using ISO date/time syntax (e.g., "2023-01-01").

      2. Then update the table at https://build.fhir.org/structuredefinition.html#metadata to include this same definition, plus the Note from the definitions: "This is a business versionId, not a resource version id (see discussion)".

      Show
      1. Update the long definition for definitions.html#StructureDefinition.version to read: >The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. There is no expectation that versions can be placed in a lexicographical sequence, so authors are encouraged to populate the StructureDefinition.versionAlgorithm [x] element to enable comparisons. If there is no managed version available, authors can consider using ISO date/time syntax (e.g., "2023-01-01"). 2. Then update the table at https://build.fhir.org/structuredefinition.html#metadata to include this same definition, plus the Note from the definitions: "This is a business versionId, not a resource version id (see discussion )".
    • Gino Canessa / Yunwei Wang: 11-0-1
    • Clarification
    • Non-substantive
    • R5

    Description

      Current text:

      The identifier that is used to identify this version of the structure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure author manually and the value should be a timestamp.

      There is no requirement or preference that version is a timestamp, although that is an option. 

      On Zulip, it was suggested that the preceding "and" should be an "or", however I don't think that is correct either.

      Attachments

        Activity

          People

            Unassigned Unassigned
            esilver Elliot Silver
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: