Release 5

Publish-box (todo)

Example StructureDefinition/Shareable (Turtle)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw Turtle (+ also see Turtle/RDF Format Specification)

Logical Model Shareable

@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .

# - resource -------------------------------------------------------------------

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

# -------------------------------------------------------------------------------------


Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.