Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Commit

Permalink
StructureDefinition updates (#1012)
Browse files Browse the repository at this point in the history
  • Loading branch information
@amcginn
amcginn authored Dec 16, 2023
1 parent 0ac5dd7 commit 47c9701
Show file tree
Hide file tree
Showing 4 changed files with 119 additions and 127 deletions.
63 changes: 29 additions & 34 deletions content/millennium/dstu2/conformance/structure-definition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,37 @@ title: StructureDefinition | DSTU 2 API

## Overview

The StructureDefinition resource describes a FHIR structure including data elements and their usage. Our current implementation uses this resource to define custom extensions.
The StructureDefinition resource describes a FHIR structure including data elements and their usage. This resource is used to define custom extensions.

The following fields are returned if valued:

* [Id](http://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
* [Publisher](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.publisher){:target="_blank"}
* [Snapshot](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.snapshot){:target="_blank"}
* [Date](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.date){:target="_blank"}
* [Fhir version](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.fhirVersion){:target="_blank"}
* [Constrained type](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.constrainedType){:target="_blank"}
* [Description](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.description){:target="_blank"}
* [Status](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.status){:target="_blank"}
* [Context type](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.contextType){:target="_blank"}
* [Context](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.context){:target="_blank"}
* [URL](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.url){:target="_blank"}
* [Kind](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.kind){:target="_blank"}
* [Differential](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.differential){:target="_blank"}
* [Abstract](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.abstract){:target="_blank"}
* [Base](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.base){:target="_blank"}
* [Name](http://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.name){:target="_blank"}

## Retrieve by id

List an individual StructureDefinition by its id:
* [ID](https://hl7.org/fhir/dstu2/resource-definitions.html#Resource.id){:target="_blank"}
* [Publisher](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.publisher){:target="_blank"}
* [Snapshot](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.snapshot){:target="_blank"}
* [Date](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.date){:target="_blank"}
* [FHIR version](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.fhirVersion){:target="_blank"}
* [Constrained type](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.constrainedType){:target="_blank"}
* [Description](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.description){:target="_blank"}
* [Status](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.status){:target="_blank"}
* [Context type](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.contextType){:target="_blank"}
* [Context](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.context){:target="_blank"}
* [URL](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.url){:target="_blank"}
* [Kind](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.kind){:target="_blank"}
* [Differential](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.differential){:target="_blank"}
* [Abstract](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.abstract){:target="_blank"}
* [Base](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.base){:target="_blank"}
* [Name](https://hl7.org/fhir/DSTU2/structuredefinition-definitions.html#StructureDefinition.name){:target="_blank"}

## Retrieve by ID

List an individual structure definition by its ID.

GET /StructureDefinition/:id

_Implementation Notes_
_Notes_

* Authentication is not required to access the StructureDefinition resource
* This resource can be retrieved by its defining URL or from the StructureDefinition resource located at the [service root URL](../../#service-root-url). For example, both of these URLs work:
* Authentication is not required to access the StructureDefinition resource.
* You can retrieve this resource by its defining URL or from the StructureDefinition resource located at the [service root URL](../../#service-root-url). For example, both of these URLs work:

`https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display`

Expand All @@ -49,15 +49,12 @@ _Implementation Notes_

Authorization is not required.

<%= authorization_types(provider: true, patient: true, system: true) %>

### Headers

<%= headers head: {Accept: 'application/json+fhir'} %>

### Example


#### Request

GET https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display
Expand All @@ -67,17 +64,15 @@ Authorization is not required.
<%= headers status: 200 %>
<%= json(:dstu2_structure_definition_bundle) %>

<%= disclaimer %>

## List of StructureDefinitions

ID | Description
----------------------------------|----------------------------------------------
[`patient-friendly-display`] | Display string suitable for patient viewing.
[`scheduling-location`] | Reference to the location of an appointment being scheduled.
[`medication-statement-category`] | Category of an order.
[`infuse-over-time`] | The length of time in minutes it took to infuse a medication.
[`encounter-guarantor`] | The guarantors of an encounter. Contains a reference to a Patient, Person, or Organization and a period when the guarantor is effective.
[`patient-friendly-display`] | The display name suitable for patient viewing.
[`scheduling-location`] | The reference to the location of a scheduled appointment.
[`medication-statement-category`] | The category of an order.
[`infuse-over-time`] | The length of time in minutes to infuse a medication.
[`encounter-guarantor`] | The guarantors of an encounter. Contains a reference to a patient, person, or organization and a period when the guarantor is effective.

[`patient-friendly-display`]: https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display?_format=json
[`scheduling-location`]: https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location?_format=json
Expand Down
Loading

0 comments on commit 47c9701

Please sign in to comment.