<status value="draft"/> <experimental value="false"/> <date value="2023-03-26T15:21:02+11:00"/> <publisher value="Health Level Seven International fhir"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <description value="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 value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <purpose value="The intent of this pattern is to ensure that artifacts have enough metadata to make sharing them through a public repository reliable."/> <fhirVersion value="5.0.0"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/fivews"/> <name value="FiveWs Pattern Mapping"/> </mapping> <kind value="logical"/> <abstract value="false"/> <type value="Shareable"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/> <snapshot> <element id="Shareable"> <path value="Shareable"/> <short value="Shareable Pattern"/> <definition value="A pattern to be followed by [canonical resources](canonicalresource.html) that meet minimal requirements for sharing via registries or similar mechanisms."/> <comment value="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 value="0"/> <max value="*"/> <base> <path value="Shareable"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Act[moodCode=DEFN]"/> </mapping> </element> <element id="Shareable.url"> <path value="Shareable.url"/> <short value="Canonical identifier for this {{title}}, represented as a URI (globally unique)"/> <definition value="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 value="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. The 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). In 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 value="Allows the {{title}} to be referenced by a single globally unique identifier."/> <min value="1"/> <max value="1"/> <base> <path value="Shareable.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".identifier"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.identifier"/> </mapping> </element> <element id="Shareable.version"> <path value="Shareable.version"/> <short value="Business version of the {{title}}"/> <definition value="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 value="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 value="1"/> <max value="1"/> <base> <path value="Shareable.version"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Shareable.versionAlgorithm[x]"> <path value="Shareable.versionAlgorithm[x]"/> <short value="How to compare versions"/> <definition value="Indicates the mechanism used to compare versions to determine which is more current."/> <comment value="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 value="0"/> <max value="1"/> <base> <path value="Shareable.versionAlgorithm[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <type> <code value="Coding"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="VersionAlgorithm"/> </extension> <strength value="extensible"/> <description value="Indicates the mechanism used to compare versions to determine which is more current"/> <valueSet value="http://hl7.org/fhir/ValueSet/version-algorithm"/> </binding> </element> <element id="Shareable.name"> <path value="Shareable.name"/> <short value="Name for this {{title}} (computer friendly)"/> <definition value="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 value="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 value="Support human navigation and code generation."/> <min value="0"/> <max value="1"/> <base> <path value="Shareable.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Shareable.title"> <path value="Shareable.title"/> <short value="Name for this {{title}} (human-friendly)"/> <definition value="A short, descriptive, user-friendly title for the {{title}}."/> <comment value="This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc."/> <min value="1"/> <max value="1"/> <base> <path value="Shareable.title"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Shareable.status"> <path value="Shareable.status"/> <short value="draft | active | retired | unknown"/> <definition value="The status of this {{title}}. Enables tracking the life-cycle of the content."/> <requirements value="Allows filtering of {{title}}s that are appropriate for use versus not."/> <min value="1"/> <max value="1"/> <base> <path value="Shareable.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="PublicationStatus"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="required"/> <description value="The lifecycle status of an artifact."/> <valueSet value="http://hl7.org/fhir/ValueSet/publication-status|5.0.0"/> </binding> </element> <element id="Shareable.experimental"> <path value="Shareable.experimental"/> <short value="For testing purposes, not real usage"/> <definition value="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 value="Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}. Allows filtering of {{title}}s that are appropriate for use versus not."/> <min value="0"/> <max value="1"/> <base> <path value="Shareable.experimental"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <meaningWhenMissing value="If experimental is not specified, the artifact is assumed NOT to be experimental"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Shareable.publisher"> <path value="Shareable.publisher"/> <short value="Name of the publisher (or steward) (organization or individual)"/> <definition value="The name of the organization or individual that published (or stewards) the {{title}}."/> <comment value="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 value="Helps establish the "authority/credibility" of the {{title}}. May also allow for contact."/> <alias value="steward"/> <min value="0"/> <max value="1"/> <base> <path value="Shareable.publisher"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="Shareable.description"> <path value="Shareable.description"/> <short value="Natural language description of the {{title}}"/> <definition value="A free text natural language description of the {{title}} from a consumer's perspective."/> <comment value="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 value="1"/> <max value="1"/> <base> <path value="Shareable.description"/> <min value="1"/> <max value="1"/> </base> <type> <code value="markdown"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="Shareable.knowledgeRepresentationLevel"> <path value="Shareable.knowledgeRepresentationLevel"/> <short value="narrative | semi-structured | structured | executable"/> <definition value="Captures the general knowledge representation level of knowledge provided by this artifact."/> <comment value="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 value="0"/> <max value="*"/> <base> <path value="Shareable.knowledgeRepresentationLevel"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="KnowledgeRepresentationLevel"/> </extension> <strength value="required"/> <description value="A level of knowledge representation provided by this artifact"/> <valueSet value="http://hl7.org/fhir/ValueSet/knowledge-representation-level|5.0.0"/> </binding> </element> </snapshot> </StructureDefinition>

to do