This page is part of the Argonaut Data Query Implementation Guide (v1.0.0: Release) based on FHIR R2. This is the current published version. For a full list of available versions, see the Directory of published versions

Conformance Statement Documentation Extension

{
  "resourceType" : "StructureDefinition",
  "id" : "argo-resource-documentation",
  "text" : {
    "status" : "generated"
  },
  "url" : "http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation",
  "name" : "Conformance Statement Documentation Extension",
  "display" : "Resource level Documentation",
  "status" : "draft",
  "publisher" : "Argonaut Project",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "other",
          "value" : "http://argonautwiki.hl7.org",
          "rank" : 0
        }
      ]
    }
  ],
  "date" : "2016-10-18T11:00:00+11:00",
  "description" : "Used in the Conformance resource to add additional information about the resource type being used by the system and allows for further documentation of server capabilities on a resource by resource basis.",
  "requirements" : "To allow for further documentation of server capabilities on a resource by resource basis.",
  "fhirVersion" : "1.0.2",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM"
    }
  ],
  "kind" : "datatype",
  "constrainedType" : "Extension",
  "abstract" : false,
  "contextType" : "resource",
  "context" : [
    "Conformance.rest.resource",
    "Conformance.rest.operation"
  ],
  "base" : "http://hl7.org/fhir/StructureDefinition/Extension",
  "snapshot" : {
    "element" : [
      {
        "id" : "resource-documentation",
        "path" : "Extension",
        "name" : "resource-documentation",
        "short" : "Addtitional conformance documentation extension",
        "definition" : "Used in the Conformance resource to add additional information about the resource type being used by the system and allows for further documentation of server capabilities on a resource by resource basis.",
        "comments" : "This is helpful for publishing the CapabilityResource narrative.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Extension",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "Extension"
          }
        ],
        "maxLength" : 0,
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "Extension:resource-documentation.id",
        "path" : "Extension.id",
        "representation" : [
          "xmlAttr"
        ],
        "name" : "Extension:resource-documentation.id",
        "short" : "xml:id (or equivalent in JSON)",
        "definition" : "unique id for the element within a resource (for internal references).",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Extension.id",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "id"
          }
        ],
        "maxLength" : 0,
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "Extension:resource-documentation.extension",
        "path" : "Extension.extension",
        "name" : "Extension:resource-documentation.extension",
        "short" : "Additional Content defined by implementations",
        "definition" : "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
        "comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias" : [
          "extensions",
          "user content"
        ],
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Extension.extension",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "Extension"
          }
        ],
        "maxLength" : 0,
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "Extension:resource-documentation.url",
        "path" : "Extension.url",
        "representation" : [
          "xmlAttr"
        ],
        "name" : "Extension:resource-documentation.url",
        "short" : "identifies the meaning of the extension",
        "definition" : "Source of the definition for the extension code - a logical name or a URL.",
        "comments" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific.  This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Extension.url",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "uri"
          }
        ],
        "fixedUri" : "http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation",
        "maxLength" : 0,
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "N/A"
          }
        ]
      },
      {
        "id" : "Extension:resource-documentation.valueMarkdown",
        "path" : "Extension.valueMarkdown",
        "name" : "Extension:resource-documentation.valueMarkdown",
        "short" : "Value of extension",
        "definition" : "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Extension.value[x]",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "markdown"
          }
        ],
        "maxLength" : 0,
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "N/A"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "resource-documentation",
        "path" : "Extension",
        "name" : "resource-documentation",
        "short" : "Addtitional conformance documentation extension",
        "definition" : "Used in the Conformance resource to add additional information about the resource type being used by the system and allows for further documentation of server capabilities on a resource by resource basis.",
        "comments" : "This is helpful for publishing the CapabilityResource narrative.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension"
          }
        ],
        "maxLength" : 0,
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "Extension:resource-documentation.url",
        "path" : "Extension.url",
        "name" : "Extension:resource-documentation.url",
        "min" : 0,
        "fixedUri" : "http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation",
        "maxLength" : 0,
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "Extension:resource-documentation.valueMarkdown",
        "path" : "Extension.valueMarkdown",
        "name" : "Extension:resource-documentation.valueMarkdown",
        "min" : 0,
        "type" : [
          {
            "code" : "markdown"
          }
        ],
        "maxLength" : 0,
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      }
    ]
  }
}