Logical Model Shareable

{
  "resourceType" : "StructureDefinition",
  "id" : "Shareable",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">to do</div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "informative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  }],
  "url" : "http://hl7.org/fhir/StructureDefinition/Shareable",
  "version" : "6.0.0-cibuild",
  "name" : "Shareable",
  "title" : "shareable",
  "status" : "draft",
  "experimental" : false,
  "date" : "2024-05-14T21:17:27+00:00",
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  },
  {
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/fiwg"
    }]
  }],
  "description" : "Logical Model: A pattern to be followed by [canonical resources](canonicalresource.html) that meet minimal requirements for sharing via registries or similar mechanisms.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "purpose" : "The intent of this pattern is to ensure that artifacts have enough metadata to make sharing them through a public repository reliable.",
  "fhirVersion" : "6.0.0-cibuild",
  "mapping" : [{
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  }],
  "kind" : "logical",
  "abstract" : false,
  "type" : "Shareable",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
  "snapshot" : {
    "element" : [{
      "id" : "Shareable",
      "path" : "Shareable",
      "short" : "Shareable Pattern",
      "definition" : "A pattern to be followed by [canonical resources](canonicalresource.html) that meet minimal requirements for sharing via registries or similar mechanisms.",
      "comment" : "The Shareable pattern establishes the minimum expectations for exchanging an artifact, including the URL, version, name, and publisher. Knowledge artifact resources would typically define a Shareable profile based on this pattern, rather than adopting the constraints directly on the resource.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "Shareable",
        "min" : 0,
        "max" : "*"
      },
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "Act[moodCode=DEFN]"
      }]
    },
    {
      "id" : "Shareable.url",
      "path" : "Shareable.url",
      "short" : "Canonical identifier for this {{title}}, represented as a URI (globally unique)",
      "definition" : "An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.",
      "comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred.  Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author.  Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
      "requirements" : "Allows the {{title}} to be referenced by a single globally unique identifier.",
      "min" : 1,
      "max" : "1",
      "base" : {
        "path" : "Shareable.url",
        "min" : 1,
        "max" : "1"
      },
      "type" : [{
        "code" : "uri"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "mapping" : [{
        "identity" : "rim",
        "map" : ".identifier"
      },
      {
        "identity" : "w5",
        "map" : "FiveWs.identifier"
      }]
    },
    {
      "id" : "Shareable.version",
      "path" : "Shareable.version",
      "short" : "Business version of the {{title}}",
      "definition" : "The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
      "comment" : "There may be different {{title}} instances that have the same identifier but different versions.  The version can be appended to the url in a reference to allow a reference to a particular business version of the {{title}} with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).",
      "min" : 1,
      "max" : "1",
      "base" : {
        "path" : "Shareable.version",
        "min" : 1,
        "max" : "1"
      },
      "type" : [{
        "code" : "string"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true
    },
    {
      "id" : "Shareable.versionAlgorithm[x]",
      "path" : "Shareable.versionAlgorithm[x]",
      "short" : "How to compare versions",
      "definition" : "Indicates the mechanism used to compare versions to determine which is more current.",
      "comment" : "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Shareable.versionAlgorithm[x]",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "string"
      },
      {
        "code" : "Coding"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "VersionAlgorithm"
        }],
        "strength" : "extensible",
        "description" : "Indicates the mechanism used to compare versions to determine which is more current",
        "valueSet" : "http://hl7.org/fhir/ValueSet/version-algorithm"
      }
    },
    {
      "id" : "Shareable.name",
      "path" : "Shareable.name",
      "short" : "Name for this {{title}} (computer friendly)",
      "definition" : "A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
      "comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
      "requirements" : "Support human navigation and code generation.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Shareable.name",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "string"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true
    },
    {
      "id" : "Shareable.title",
      "path" : "Shareable.title",
      "short" : "Name for this {{title}} (human-friendly)",
      "definition" : "A short, descriptive, user-friendly title for the {{title}}.",
      "comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
      "min" : 1,
      "max" : "1",
      "base" : {
        "path" : "Shareable.title",
        "min" : 1,
        "max" : "1"
      },
      "type" : [{
        "code" : "string"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true
    },
    {
      "id" : "Shareable.status",
      "path" : "Shareable.status",
      "short" : "draft | active | retired | unknown",
      "definition" : "The status of this {{title}}. Enables tracking the life-cycle of the content.",
      "requirements" : "Allows filtering of {{title}}s that are appropriate for use versus not.",
      "min" : 1,
      "max" : "1",
      "base" : {
        "path" : "Shareable.status",
        "min" : 1,
        "max" : "1"
      },
      "type" : [{
        "code" : "code"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : true,
      "isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "PublicationStatus"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
          "valueBoolean" : true
        }],
        "strength" : "required",
        "description" : "The lifecycle status of an artifact.",
        "valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|6.0.0-cibuild"
      }
    },
    {
      "id" : "Shareable.experimental",
      "path" : "Shareable.experimental",
      "short" : "For testing purposes, not real usage",
      "definition" : "A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
      "requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}.\n\nAllows filtering of {{title}}s that are appropriate for use versus not.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Shareable.experimental",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "boolean"
      }],
      "meaningWhenMissing" : "If experimental is not specified, the artifact is assumed NOT to be experimental",
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true
    },
    {
      "id" : "Shareable.publisher",
      "path" : "Shareable.publisher",
      "short" : "Name of the publisher (or steward) (organization or individual)",
      "definition" : "The name of the organization or individual that published (or stewards) the {{title}}.",
      "comment" : "Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the {{title}}. This item SHOULD be populated unless the information is available from context.",
      "requirements" : "Helps establish the \"authority/credibility\" of the {{title}}.  May also allow for contact.",
      "alias" : ["steward"],
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Shareable.publisher",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "string"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true
    },
    {
      "id" : "Shareable.description",
      "path" : "Shareable.description",
      "short" : "Natural language description of the {{title}}",
      "definition" : "A free text natural language description of the {{title}} from a consumer's perspective.",
      "comment" : "This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the {{title}} is presumed to be the predominant language in the place the {{title}} was created).",
      "min" : 1,
      "max" : "1",
      "base" : {
        "path" : "Shareable.description",
        "min" : 1,
        "max" : "1"
      },
      "type" : [{
        "code" : "markdown"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false
    },
    {
      "id" : "Shareable.knowledgeRepresentationLevel",
      "path" : "Shareable.knowledgeRepresentationLevel",
      "short" : "narrative | semi-structured | structured | executable",
      "definition" : "Captures the general knowledge representation level of knowledge provided by this artifact.",
      "comment" : "Knowledge representation level provides consumers with a general overview of the level(s) of knowledge representation afforded by a knowledge artifact, narrative, semi-structured, structured, and executable.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "Shareable.knowledgeRepresentationLevel",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "KnowledgeRepresentationLevel"
        }],
        "strength" : "required",
        "description" : "A level of knowledge representation provided by this artifact",
        "valueSet" : "http://hl7.org/fhir/ValueSet/knowledge-representation-level|6.0.0-cibuild"
      }
    }]
  }
}