Argonaut Data Query Implementation Guide Version 1.0.0

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

D.4.1 StructureDefinition-argo-resource-documentation

resource-documentation Extension

Context of Use:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation

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.

This profile builds on Extension.

This profile was published on Tue Oct 18 11:00:00 AEDT 2016 as a draft by Argonaut Project.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Summary of the Mandatory Requirements

  1. MAY use this extension to provide additional documentation for a supported resource or operation in the Conformance resource.
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Addtitional conformance documentation extension
... url 0.."http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"
... valueMarkdown 0..markdown

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Addtitional conformance documentation extension
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... url 1..1uri"http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"
... valueMarkdown 0..1markdownValue of extension

doco Documentation for this format

Summary of the Mandatory Requirements

  1. MAY use this extension to provide additional documentation for a supported resource or operation in the Conformance resource.

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Addtitional conformance documentation extension
... url 0.."http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"
... valueMarkdown 0..markdown

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Addtitional conformance documentation extension
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... url 1..1uri"http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"
... valueMarkdown 0..1markdownValue of extension

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

D.4.1.2 Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the Argonaut Data Query implementation guide server for a complete list of supported RESTful operations and search parameters for this IG.

No Search criteria for argo-resource-documentation extension.