{
  "resourceType": "StructureDefinition",
  "id": "CanonicalResource",
  "meta": {
    "lastUpdated": "2021-01-01T21:58:31.578+00:00"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-interface",
      "valueBoolean": true
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "normative"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
      "valueCode": "4.2.0"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 5
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status",
      "valueCode": ".status = retired"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/CanonicalResource",
  "version": "4.6.0",
  "name": "CanonicalResource",
  "status": "active",
  "date": "2021-01-01T21:58:31+00:00",
  "publisher": "Health Level Seven International (FHIR Infrastructure)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
        }
      ]
    }
  ],
  "description": "Common Ancestor declaration for conformance and knowledge artifact resources.",
  "fhirVersion": "4.6.0",
  "mapping": [
    {
      "identity": "workflow",
      "uri": "http://hl7.org/fhir/workflow",
      "name": "Workflow Pattern"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern Mapping"
    },
    {
      "identity": "objimpl",
      "uri": "http://hl7.org/fhir/object-implementation",
      "name": "Object Implementation Information"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "resource",
  "abstract": true,
  "type": "CanonicalResource",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
  "derivation": "specialization",
  "differential": {
    "element": [
      {
        "id": "CanonicalResource",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/svg",
            "valueCode": "230,160"
          }
        ],
        "path": "CanonicalResource",
        "short": "Common Ancestor declaration for definitional resources",
        "definition": "Common Ancestor declaration for conformance and knowledge artifact resources.",
        "min": 1,
        "max": "1",
        "constraint": [
          {
            "key": "cnl-0",
            "severity": "warning",
            "human": "Name should be usable as an identifier for the module by machine processing applications such as code generation",
            "expression": "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
            "xpath": "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')",
            "source": "http://hl7.org/fhir/StructureDefinition/CanonicalResource"
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition"
          },
          {
            "identity": "w5",
            "map": "conformance.behavior"
          }
        ]
      },
      {
        "id": "CanonicalResource.url",
        "path": "CanonicalResource.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 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": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.url"
          },
          {
            "identity": "w5",
            "map": "FiveWs.identifier"
          }
        ]
      },
      {
        "id": "CanonicalResource.identifier",
        "path": "CanonicalResource.identifier",
        "short": "Additional identifier for the {{title}}",
        "definition": "A formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.",
        "comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this {{title}} outside of FHIR, where it is not possible to use the logical URI.",
        "requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.identifier"
          },
          {
            "identity": "objimpl",
            "map": "no-gen-base"
          },
          {
            "identity": "w5",
            "map": "FiveWs.identifier"
          }
        ]
      },
      {
        "id": "CanonicalResource.version",
        "path": "CanonicalResource.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].",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.version"
          },
          {
            "identity": "w5",
            "map": "FiveWs.version"
          }
        ]
      },
      {
        "id": "CanonicalResource.name",
        "path": "CanonicalResource.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",
        "type": [
          {
            "code": "string"
          }
        ],
        "condition": [
          "cnl-0"
        ],
        "isSummary": true
      },
      {
        "id": "CanonicalResource.title",
        "path": "CanonicalResource.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": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.title"
          }
        ]
      },
      {
        "id": "CanonicalResource.status",
        "path": "CanonicalResource.status",
        "short": "draft | active | retired | unknown",
        "definition": "The status of this {{title}}. Enables tracking the life-cycle of the content.",
        "comment": "Allows filtering of {{title}}s that are appropriate for use versus not.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "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"
        },
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.status"
          },
          {
            "identity": "w5",
            "map": "FiveWs.status"
          }
        ]
      },
      {
        "id": "CanonicalResource.experimental",
        "path": "CanonicalResource.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.",
        "comment": "Allows filtering of {{title}}s that are appropriate for use versus not.",
        "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.experimental"
          },
          {
            "identity": "w5",
            "map": "FiveWs.class"
          }
        ]
      },
      {
        "id": "CanonicalResource.date",
        "path": "CanonicalResource.date",
        "short": "Date last changed",
        "definition": "The date  (and optionally time) when the {{title}} was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changes.",
        "comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
        "alias": [
          "Revision Date"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.date"
          },
          {
            "identity": "w5",
            "map": "FiveWs.recorded"
          }
        ]
      },
      {
        "id": "CanonicalResource.publisher",
        "path": "CanonicalResource.publisher",
        "short": "Name of the publisher (organization or individual)",
        "definition": "The name of the organization or individual that published 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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.publisher"
          },
          {
            "identity": "w5",
            "map": "FiveWs.witness"
          }
        ]
      },
      {
        "id": "CanonicalResource.contact",
        "path": "CanonicalResource.contact",
        "short": "Contact details for the publisher",
        "definition": "Contact details to assist a user in finding and communicating with the publisher.",
        "comment": "May be a web site, an email address, a telephone number, etc.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "ContactDetail"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.contact"
          }
        ]
      },
      {
        "id": "CanonicalResource.description",
        "path": "CanonicalResource.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 why the {{title}} was built, 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": 0,
        "max": "1",
        "type": [
          {
            "code": "markdown"
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.description"
          }
        ]
      },
      {
        "id": "CanonicalResource.useContext",
        "path": "CanonicalResource.useContext",
        "short": "The context that the content is intended to support",
        "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}} instances.",
        "comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
        "requirements": "Assist in searching for appropriate content.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "UsageContext"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.useContext"
          }
        ]
      },
      {
        "id": "CanonicalResource.jurisdiction",
        "path": "CanonicalResource.jurisdiction",
        "short": "Intended jurisdiction for {{title}} (if applicable)",
        "definition": "A legal or geographic region in which the {{title}} is intended to be used.",
        "comment": "It may be possible for the {{title}} to be used in jurisdictions other than those for which it was originally designed or intended.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "Jurisdiction"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
              "valueBoolean": true
            }
          ],
          "strength": "extensible",
          "description": "Countries and regions within which this artifact is targeted for use.",
          "valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction"
        },
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.jurisdiction"
          }
        ]
      },
      {
        "id": "CanonicalResource.purpose",
        "path": "CanonicalResource.purpose",
        "short": "Why this {{title}} is defined",
        "definition": "Explanation of why this {{title}} is needed and why it has been designed as it has.",
        "comment": "This element does not describe the usage of the {{title}}. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is.  This may be used to point to source materials or specifications that drove the structure of this {{title}}.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "markdown"
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.purpose"
          },
          {
            "identity": "objimpl",
            "map": "no-gen-base"
          },
          {
            "identity": "w5",
            "map": "FiveWs.why[x]"
          }
        ]
      },
      {
        "id": "CanonicalResource.copyright",
        "path": "CanonicalResource.copyright",
        "short": "Use and/or publishing restrictions",
        "definition": "A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.",
        "requirements": "Consumers must be able to determine any legal restrictions on the use of the {{title}} and/or its content.",
        "alias": [
          "License",
          "Restrictions"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "markdown"
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.copyright"
          },
          {
            "identity": "objimpl",
            "map": "no-gen-base"
          }
        ]
      }
    ]
  }
}