SD.5 StructureDefinition-template-basic
Profile template-basic.md file
Conformance resource variables defined here
id = template-basic
- index : a local id for the structure: {{site.data.structuredefinitions.[id].index}} = 4
- url : full canonical url for the structure: {{site.data.structuredefinitions.[id].url}} = http://www.fhir.org/guides/sampler2/StructureDefinition/template-basic
- name : the name given for it: {{site.data.structuredefinitions.[id].name}} = Profile template-basic
- path : the path to it in the built html: {{site.data.structuredefinitions.[id].path}} = StructureDefinition-template-basic.html
- kind : the kind (complex data type, resource, logical model): {{site.data.structuredefinitions.[id].kind}} = resource
- type : the base type: {{site.data.structuredefinitions.[id].type}} = Basic
- base : the url for structure definition from which it derives: {{site.data.structuredefinitions.[id].base}} = http://hl7.org/fhir/StructureDefinition/Basic
- basename : the name of the structure definition from which it derives: {{site.data.structuredefinitions.[id].basename}} = Basic
- basepath : the url to the structure definition from which it derives: {{site.data.structuredefinitions.[id].basepath}} = http://hl7.org/fhir/STU3/basic.html
- status : the status (draft, active, retired): {{site.data.structuredefinitions.[id].status}} = draft
- date : the date in the resource: {{site.data.structuredefinitions.[id].date}} = Wed Feb 15 00:00:00 PST 2017
- publisher : the stated publisher: {{site.data.structuredefinitions.[id].publisher}} =
- copyright : the stated copyright for the resource: {{site.data.structuredefinitions.[id].copyright}} =
- description : the description for the resource: {{site.data.structuredefinitions.[id].description}} =
- contextType : the type of context associated with an extension structure definition: {{site.data.structuredefinitions.[id].contextType}} =
- contexts : an array of paths for each allowed context path for an extension: {{site.data.structuredefinitions.[id].contexts}} =
This is the introduction markdown file that gets inserted into the sd.html template.
This profile sets minimum expectations for blah blah blah
Mandatory Data Elements and Terminology
The following data-elements are mandatory (i.e data MUST be present). blah blah blah
must have:
- blah
- blah
- blah
Additional Profile specific implementation guidance:
Examples
SD.5.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://www.fhir.org/guides/sampler2/StructureDefinition/template-basic
Published on Wed Feb 15 00:00:00 PST 2017 as a draft by .
This profile builds on Basic
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Basic | I | 0..* | temp-1: Identifier SHALL be greater than 5 characters | |
  identifier | SI | 1..1 | Identifier | |
| code | S | 1..1 | CodeableConcept | |
  coding | S | 1..1 | Coding | |
  code | S | 1..1 | code | Fixed Value: diet |
 subject | S | 1..1 | Reference(US Core Patient Profile) | |
 extension-blah | S | 0..1 | code | Example extension URL: http://www.fhir.org/guides/sampler2/StructureDefinition/extension-blah Binding: BlahCodes (required) |
 extension-complex | S | 0..1 | (Complex) | Example complex extension URL: http://www.fhir.org/guides/sampler2/StructureDefinition/extension-complex |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Basic | I | 0..* | Resource for non-supported content temp-1: Identifier SHALL be greater than 5 characters | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
| extension-blah | SI | 0..1 | code | Example extension URL: http://www.fhir.org/guides/sampler2/StructureDefinition/extension-blah Binding: BlahCodes (required) |
| extension-complex | SI | 0..1 | (Complex) | Example complex extension URL: http://www.fhir.org/guides/sampler2/StructureDefinition/extension-complex |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 1..1 | Identifier | Business identifier |
| code | ?!SΣ | 1..1 | CodeableConcept | Kind of Resource Binding: Basic Resource Types (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: diet |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Identifies the focus of this resource |
| created | Σ | 0..1 | date | When created |
| author | Σ | 0..1 | Reference(Practitioner), Reference(Patient), Reference(RelatedPerson) | Who created |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
SD.5.2 Quick Start
Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.
Template-basic-search.md file
This is the search markdown file that gets inserted into the sd.html Quick Start section for explanation of the search requirements.
GET /Basic?patient={id}
Example:
[example here]
Support: e.g. Mandatory for client to support search by patient. Optional for server to support.
Implementation Notes: blah blah blah
Response Class:
- (Status 200): successful operation
- (Status 400): invalid parameter
- (Status 401/4xx): unauthorized request
- (Status 403): insufficient scope
