Simplifier.net

https://docs.fire.ly/projects/Simplifier/
Admin
Simplifier.net is a FHIR specification development, collaboration, and publishing platform.
Tokens:29,242
Snippets:230
Trust Score:9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Page Header Properties Example

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

An example of a YAML header for a markdown page, setting properties like 'topic', 'name', and 'expand'.

```yaml
---
topic: MyPatientPage
name: ACMEbasePatient
expand: 2
---
```

--------------------------------

### Linking to Resources by ID

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

Explains the recommended method for linking to examples or other resources using their ResourceType and ID. This ensures links remain functional across guide exports or duplications, supporting Link, XML, and JSON renderings.

```markdown
{{Link/xml/json: ResourceType/id}}
```

```markdown
{{link: Patient/child-example}}
```

```markdown
{{json: Patient/child-example}}
```

--------------------------------

### FQL Syntax Example

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

Demonstrates the basic syntax for FQL (Firely Query Language) to create dynamic tables by selecting data from resources. It requires specifying the resource source, filtering conditions, and desired output fields.

```sql
from <your recources>
where <option>
select <what you want in the table>
```

--------------------------------

### Start Firely Server

Source: https://docs.fire.ly/projects/Simplifier/features/simplifierFirely-server

Executes the PowerShell script to start the Firely Server. This script pulls Docker images, starts containers, and imports FHIR conformance resources and examples from Simplifier.

```powershell
.\start-vonk-server.ps1

```

--------------------------------

### Markdown Formatting Examples

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

Examples of common Markdown syntax used in the Simplifier IG editor for text formatting, including headers, emphasis, bolding, combined emphasis, and strikethrough.

```Markdown
#Header size 1

```

```Markdown
######Header size 6

```

```Markdown
*asterisks* or _underscores_

```

```Markdown
**asterisks** or __underscores__

```

```Markdown
**asterisks_and_underscores**

```

```Markdown
~~Scratch this.~~

```

--------------------------------

### JSON Rendering of a Resource Example

Source: https://docs.fire.ly/projects/Simplifier/implementation_guide/create_your_first_ig

Shows how to render a specific resource example in JSON format using the `json` command followed by the resource type and ID.

```Wiki Markup
{{json: Patient/child-example}}
```

--------------------------------

### Move Examples to Package Examples Folder

Source: https://docs.fire.ly/projects/Simplifier/data_governance_and_quality_control/simplifierPackages

This optional configuration moves all example resources (categorized as 'Instance') from 'bucket1' to the '/package/examples' directory, targeting 'output'.

```yaml
move-examples:
  - source: bucket1
  - category: Instance
  - move: /package/examples
  - target: output
```

--------------------------------

### Simplifier Resolve URL Example

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/simplifierDocumentationRedirection

Provides an example of a direct URL to resolve a resource's documentation on Simplifier, detailing the components and their purpose.

```url
https://simplifier.net/resolve?fhirVersion=R4&scope=hl7.fhir.r4.core@4.0.1&canonical=
```

--------------------------------

### FHIR Implementation Guide 'tree' command examples

Source: https://docs.fire.ly/projects/Simplifier/simplifierReleaseNotes

Demonstrates the usage of the 'tree' command in FHIR Implementation Guides with 'expand' and 'lang' properties. The 'expand' property allows for full expansion or expansion to a specified level, while 'lang' allows switching the rendering language.

```markdown
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, expand}}
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, expand: 2}}
```

```markdown
{{tree:http://hl7.org/fhir/fhir-be/StructuurDefinities/Patient, lang: fr-BE}}
```

--------------------------------

### Link to a Specific Resource Example

Source: https://docs.fire.ly/projects/Simplifier/implementation_guide/create_your_first_ig

Demonstrates linking to a specific resource example, likely a patient resource, using the `link` command with the resource type and ID.

```Wiki Markup
{{link: Patient/child-example}}
```

--------------------------------

### Fetch FHIR Resources from Server (GET)

Source: https://docs.fire.ly/projects/Simplifier/getting_started/simplifierProjects

Demonstrates how to fetch a single FHIR resource (Patient with id 'example') from a FHIR server using a GET request.

```HTTP
http://example.org/fhir/Patient/example
```

--------------------------------

### Example Resolve URL Structure

Source: https://docs.fire.ly/projects/Simplifier/features/simplifierDocumentationRedirection

This example demonstrates the structure of a direct resolve URL for Simplifier.net, showing how to specify FHIR version, scope, and resource canonical.

```General
https://simplifier.net/resolve?fhirVersion=R4&scope=hl7.fhir.r4.core@4.0.1&canonical=
```

--------------------------------

### Markdown Formatting Examples

Source: https://docs.fire.ly/projects/Simplifier/implementation_guide/create_your_first_ig

Examples of common markdown syntax used in the Simplifier IG editor for text formatting, including headers, emphasis, strong emphasis, combined emphasis, and strikethrough.

```markdown
#Header size 1
######Header size 6
*asterisks*
_underscores_
**asterisks**
__underscores__
**asterisks** and _underscores_**
~~Scratch this.~~
```

--------------------------------

### Access Example Resources

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/simplifierFirely-server

Access example resources that are part of the project the Firely Server was created from. These are available through the regular FHIR endpoint.

```APIDOC
## GET /[resource_type]

### Description
Accesses example FHIR resources (e.g., Patient, Observation) that are included in the Simplifier project powering the Firely Server. You can add specific search parameters to narrow down the results.

### Method
GET

### Endpoint
`/` followed by a more specific search path, e.g., `/Patient` or `/StructureDefinition`.

### Parameters
#### Query Parameters
- **(Varies)** - Optional - Standard FHIR search parameters can be used to filter resources.

### Request Example
```
GET http://127.0.0.1:8080/Patient?name=John
```

### Response
#### Success Response (200)
- **resourceType** (string) - The type of the resource being requested (e.g., 'Bundle', 'Patient').
- **entry** (array) - If a bundle is returned, this contains the list of resources.
- **(resource)** - The requested FHIR resource(s).

#### Response Example
```json
{
  "resourceType": "Bundle",
  "entry": [
    {
      "resource": {
        "resourceType": "Patient",
        "id": "example-patient-1",
        "name": [
          {
            "family": "Smith",
            "given": [
              "John"
            ]
          }
        ]
      }
    }
  ]
}
```
```

--------------------------------

### Simplifier Rules for Package Manifest and Dependencies (Example)

Source: https://docs.fire.ly/projects/Simplifier/simplifierReleaseNotes

Demonstrates the usage of new rules for checking package manifests and dependencies in Simplifier. It includes rules for unique filenames, assertion checks with severity levels, and new predicates for existence, min, max, count, and cardinality. The example also covers manifest correctness and dependency analysis with upgrade suggestions.

```text
unique-filename : Checks for duplicate files in package builds.
assert : Can now check for any issue, or issues of specified severity (warning, error, or info).
New predicates: exists, min, max, count, and cardinality.
manifest : Evaluates the correctness of `package.json`.
dependency : Provides a full analysis of your dependency closure, including upgrade suggestions.
```

--------------------------------

### Start Firely Server Script

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/simplifierFirely-server

Executes the PowerShell script to start the Firely Server. This script pulls Docker images, starts containers, and imports FHIR conformance and project resources.

```powershell
.\start-vonk-server.ps1
```

--------------------------------

### Create Example Connector Script - Javascript

Source: https://docs.fire.ly/projects/Simplifier/features/simplifierConnectors

A trivial Javascript connector script that redirects the current webpage to example.com, passing the FHIR resource endpoint and a callback URL as parameters. This allows external services to fetch resource details and generate examples.

```javascript
// trivial connector that redirects the webpage to example.com with a parameter to the resource
// the connector was used with
window.location.href = "http://example.com/createExample?profile="+simplifierServer.ResourceEndpoint+"&callbackurl="+returnUrl;
```

--------------------------------

### Creating Tabs

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

Example of creating tabs for different content, including using the 'tree' and 'xml' widgets. The 'active="true"' attribute makes a tab active by default.

```html
<tabs>
    <tab title="Overview">
      {{tree:http://hl7.org/fhir/StructureDefinition/Patient}}
    </tab>
    <tab title="Xml" active="true">
      {{xml:http://hl7.org/fhir/StructureDefinition/Patient}}
    </tab>
</tabs>
```

--------------------------------

### Pagelink with Topic for Robust Linking

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

Illustrates how to set a 'topic' in the YAML header of an Implementation Guide page to create more resilient pagelinks. Using the topic name in the pagelink command prevents broken links when the guide is copied or modified.

```yaml
---
topic: yourpagename
---
```

```markdown
{{pagelink:yourpagename}}
```

--------------------------------

### Basic Pagelink Syntax

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

Shows the fundamental syntax for creating a pagelink to another page within an Implementation Guide using a URL key. This method links directly to a specific markdown resource.

```markdown
{{pagelink:<url key for the markdown resource describing the page>}}
```

--------------------------------

### Access Example Resources

Source: https://docs.fire.ly/projects/Simplifier/features/simplifierFirely-server

This code snippet shows how to access example resources if they exist in the Simplifier project that the Firely Server was created from. Resources are available at the normal FHIR endpoint.

```HTTP
GET http://127.0.0.1:8080/<more specific search if you want>
```

--------------------------------

### IG Editor: Tabs with active tab selection

Source: https://docs.fire.ly/projects/Simplifier/_sources/simplifierReleaseNotes

Provides an example of how to create tabbed content within an Implementation Guide page, using the 'active' flag to specify the default visible tab.

```html
<tabs>
      <tab title="Overview">
            {{tree:http://hl7.org/fhir/StructureDefinition/Patient}}
      </tab>
      <tab title="Xml" active="true">
            {{xml:http://hl7.org/fhir/StructureDefinition/Patient}}
      </tab>
</tabs>
```

--------------------------------

### Features API: Get User Projects (GET)

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/api

Fetches a list of Simplifier.net projects accessible to the authenticated user. This GET request is made to the '/api/v2/myprojects' endpoint.

```HTTP
GET https://api.simplifier.net/api/v2/myprojects
```

--------------------------------

### Create Internal Page Link using Topic

Source: https://docs.fire.ly/projects/Simplifier/implementation_guide/create_your_first_ig

Creates a robust link to another page within the Implementation Guide by referencing its 'topic'. This method ensures links remain functional even if the guide is duplicated or URL keys change.

```Wiki Markup
{{pagelink:yourpagename}}
```

--------------------------------

### Tree Widget Renderings

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

Demonstrates how to use the 'tree' widget to display different forms of a resource. Accepts a resource URL and a rendering type (diff, snap, hybrid).

```text
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, diff}}
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, snap}}
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, hybrid}}
```

--------------------------------

### Tree Widget Buttons

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

Shows how to use the 'buttons' property with the 'tree' widget to display diff, snap, and hybrid rendering options.

```text
{{tree:http://hl7.org/fhir/StructuurDefinities/Patient, buttons}}
```

--------------------------------

### Access Example Resources via FHIR Endpoint

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/simplifierFirely-server

This snippet shows how to access example resources that are part of your Simplifier project. These resources are available through the regular FHIR endpoint of the running Firely Server.

```HTTP
GET http://127.0.0.1:8080/<more specific search if you want>
```

--------------------------------

### Simplifier IG Content Rendering Statements

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

These statements are used within the Simplifier IG editor to embed different representations of resources directly into the guide's content. After adding these, refresh the page to see them in the preview. The rendering depends on the IG's scope setting.

```Simplifier Template
{{tree:canonicalUrl}}

```

```Simplifier Template
{{json:canonicalUrl}}

```

```Simplifier Template
{{xml:canonicalUrl}}

```

```Simplifier Template
{{table:canonicalUrl}}

```

```Simplifier Template
{{link:canonicalUrl}}

```

```Simplifier Template
{{namingsystems:ProjectName}}

```

```Simplifier Template
{{render:canonicalUrl}}

```

```Simplifier Template
{{source:canonicalUrl}}

```

--------------------------------

### Package Server API: NPM Compatible Endpoint

Source: https://docs.fire.ly/projects/Simplifier/features/api

Example of an NPM compatible endpoint for downloading FHIR packages.

```http
https://packages.simplifier.net/<package-name>/-/<package-name>-<package-version>.tgz


```

```http
https://packages.simplifier.net/hl7.fhir.r3.core/-/hl7.fhir.r3.core-3.0.2.tgz


```

--------------------------------

### Tree Widget Expansion

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

Illustrates using the 'expand' property with the 'tree' widget for full or level-specific expansion of a resource tree.

```text
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, expand}}
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, expand: 2}}
```

--------------------------------

### FHIR Implementation Guide 'source' command

Source: https://docs.fire.ly/projects/Simplifier/simplifierReleaseNotes

Demonstrates the new 'source' command, which explicitly renders unparsed files. For profiles, it shows the XML or JSON, and for FQL files, it renders the script text, offering explicit control over file rendering.

```markdown
{{source:http://hl7.org/fhir/StructureDefinition/Patient}}
```

--------------------------------

### Search Global FHIR Resources (STU3 Patient Example)

Source: https://docs.fire.ly/projects/Simplifier/features/api

Enables searching for all FHIR resources across Simplifier. This example demonstrates retrieving all STU3 Patient resources.

```HTTP
GET https://stu3.simplifier.net/open/Patient
```

--------------------------------

### Creating Tabs with Widgets

Source: https://docs.fire.ly/projects/Simplifier/implementation_guide/create_your_first_ig

Illustrates the syntax for creating tabs on a guide page. Each tab can contain different widgets, and the 'active' attribute can specify the initially displayed tab.

```HTML/Liquid
<tabs>
    <tab title="Overview">
      {{tree:http://hl7.org/fhir/StructureDefinition/Patient}}
    </tab>
    <tab title="Xml" active="true">
      {{xml:http://hl7.org/fhir/StructureDefinition/Patient}}
    </tab>
</tabs>
```

--------------------------------

### Tree Widget Language Setting

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

Demonstrates setting the language for the 'tree' widget rendering using the 'lang' property.

```text
{{tree:http://hl7.be/fhir/be/StructuurDefinities/Patient, lang: fr-BE}}
```

--------------------------------

### Features API - Get My Projects

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/api

Retrieve a list of Simplifier.net projects accessible to the authenticated user.

```APIDOC
## GET /api/v2/myprojects

### Description
Retrieves a list of Simplifier.net projects that the authenticated user has access to.

### Method
GET

### Endpoint
https://api.simplifier.net/api/v2/myprojects

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication. Format: `Bearer <access_token>`.

### Response
#### Success Response (200)
- (Array of Objects) - A list of projects, each with details like name and URL key.

#### Response Example
```json
[
  {
    "name": "Project Alpha",
    "urlKey": "project-alpha"
  },
  {
    "name": "Project Beta",
    "urlKey": "project-beta"
  }
]
```
```

--------------------------------

### Package Server API - NPM Compatible Endpoint

Source: https://docs.fire.ly/projects/Simplifier/features/api

Install FHIR packages using an NPM-compatible endpoint.

```APIDOC
## NPM Compatible FHIR Packages

### Description
Provides an NPM-compatible endpoint for installing FHIR packages using NPM clients. Note: this mixes FHIR packages with NPM packages and lacks FHIR-specific features.

### Method
GET

### Endpoint
https://packages.simplifier.net/<package-name>/-/ <package-name>-<package-version>.tgz

### Parameters
- **package-name** (string) - Required - The name of the FHIR package (e.g., `hl7.fhir.r3.core`).
- **package-version** (string) - Required - The version of the FHIR package (e.g., `3.0.2`).

### Request Example
```
https://packages.simplifier.net/hl7.fhir.r3.core/-/hl7.fhir.r3.core-3.0.2.tgz
```

### Response
#### Success Response (200)
- Returns the FHIR package as a `.tgz` file.
```

--------------------------------

### Page Header Configuration (YAML)

Source: https://docs.fire.ly/projects/Simplifier/implementation_guide/create_your_first_ig

Example of a YAML header for a markdown page, used to set page-level properties like 'topic', 'name', and 'expand'. These properties can influence rendering widgets on the page.

```YAML
---
topic: MyPatientPage
name: ACMEbasePatient
expand: 2
---
```

--------------------------------

### NPM Compatible Endpoint

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/api

Install FHIR packages using an NPM client via a dedicated endpoint.

```APIDOC
## NPM Compatible Endpoint

### Description
A limited endpoint compatible with NPM clients for installing FHIR packages. Note that this may mix FHIR packages with regular NPM packages and does not support FHIR-specific features.

### Method
(NPM client specific)

### Endpoint
(NPM registry endpoint for FHIR packages)

### Parameters
(NPM client specific package installation parameters)

### Response
(NPM package installation response)
```

--------------------------------

### FHIR Implementation Guide 'render' command enhancements

Source: https://docs.fire.ly/projects/Simplifier/simplifierReleaseNotes

Shows how to use the 'render' command with the 'buttons' property to display 'diff', 'snap', and 'hybrid' buttons for a tree. It also illustrates setting default tabs using the 'active' flag within a '<tabs>' structure.

```markdown
<tabs>
      <tab title="Overview">
            {{tree:http://hl7.org/fhir/StructureDefinition/Patient}}
      </tab>
      <tab title="Xml" active="true">
            {{xml:http://hl7.org/fhir/StructureDefinition/Patient}}
      </tab>
</tabs>
```

--------------------------------

### Features API - Get My Projects

Source: https://docs.fire.ly/projects/Simplifier/features/api

Retrieve a list of Simplifier.net projects accessible by the authenticated user.

```APIDOC
## GET /api/v2/myprojects

### Description
Returns a list of Simplifier.net projects associated with the authenticated user.

### Method
GET

### Endpoint
https://api.simplifier.net/api/v2/myprojects

### Parameters
#### Headers
- **Authorization** (string) - Required - `Bearer <access_token>`

### Request Example
```json
{
  "Authorization": "Bearer <access_token>"
}
```

### Response
#### Success Response (200)
- **projects** (array) - A list of project objects.
  - **name** (string) - The name of the project.
  - **urlKey** (string) - The unique URL key for the project.

### Response Example
```json
{
  "projects": [
    {
      "name": "My First Project",
      "urlKey": "my-first-project"
    },
    {
      "name": "FHIR Resources",
      "urlKey": "fhir-resources"
    }
  ]
}
```
```

--------------------------------

### Link to Resources by Resource ID

Source: https://docs.fire.ly/projects/Simplifier/implementation_guide/create_your_first_ig

Provides a method to link to internal resources (examples, etc.) using their ResourceType and ID. This ensures links remain functional across different export formats and duplications. A ResourceType must always be specified.

```Wiki Markup
{{Link/xml/json: ResourceType/id}}
```

--------------------------------

### Features API: Get User Projects

Source: https://docs.fire.ly/projects/Simplifier/features/api

Retrieves a list of Simplifier.net projects accessible to the user.

```http
GET https://api.simplifier.net/api/v2/myprojects


```

--------------------------------

### Set Page Topic for Robust Linking

Source: https://docs.fire.ly/projects/Simplifier/implementation_guide/create_your_first_ig

Defines a 'topic' for a page in the YAML header, which can then be used in `pagelink` commands for more stable internal linking. This prevents links from breaking when guides are copied or modified.

```YAML
---
topic: yourpagename
---
```

--------------------------------

### Features API - Get My Features

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/api

Retrieve the features available for your current Simplifier plan.

```APIDOC
## GET /myfeatures

### Description
Returns the features that the authenticated user is permitted to use based on their current plan.

### Method
GET

### Endpoint
https://api.simplifier.net/myfeatures

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication. Format: `Bearer <access_token>`.

### Response
#### Success Response (200)
- (Object) - An object containing the user's available features.

#### Response Example
```json
{
  "features": [
    "feature1",
    "feature2"
  ]
}
```
```

--------------------------------

### Page Header Language Setting

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

Shows how to set the 'lang' property in a YAML header to affect all renderers on the page.

```yaml
---
lang: nl-BE
---
```

--------------------------------

### Features API - Get My Features

Source: https://docs.fire.ly/projects/Simplifier/features/api

Retrieve the features and plan entitlements for the authenticated user.

```APIDOC
## GET /myfeatures

### Description
Returns the features that the authenticated user is entitled to use based on their current plan.

### Method
GET

### Endpoint
https://api.simplifier.net/myfeatures

### Parameters
#### Headers
- **Authorization** (string) - Required - `Bearer <access_token>`

### Request Example
```json
{
  "Authorization": "Bearer <access_token>"
}
```

### Response
#### Success Response (200)
- **features** (object) - An object containing the user's features and plan details.

### Response Example
```json
{
  "features": {
    "planName": "Pro",
    "availableFeatures": [
      "ProjectManagement",
      "ApiAccess"
    ]
  }
}
```
```

--------------------------------

### YAML header for IG rendering configuration

Source: https://docs.fire.ly/projects/Simplifier/simplifierReleaseNotes

Illustrates configuring rendering properties like 'lang', 'expand', and 'buttons' within the YAML header of a markdown page in an Implementation Guide. This allows for centralized configuration of rendering commands.

```yaml
---
lang: nl-BE
---
```

--------------------------------

### Retrieve Summary of Structure Definitions

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/api

This example shows how to fetch a summarized view of StructureDefinitions for a given project. The '_summary=true' parameter limits the returned fields.

```http
GET https://stu3.simplifier.net/<yourproject>/StructureDefinition?_summary=true
```

--------------------------------

### Enable PowerShell Script Execution

Source: https://docs.fire.ly/projects/Simplifier/features/simplifierFirely-server

Temporarily allows the execution of downloaded PowerShell scripts within the current process. This is necessary because the provided Firely Server start script is not signed.

```powershell
Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process

```

--------------------------------

### JQuery AJAX GET Request

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/simplifierConnectors

Shows how to use JQuery's $.get() function to fetch data from a server.

```Javascript
$.get(url).success(function()
{
	
});
```

--------------------------------

### Features API - Get Project Files

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/api

List all files contained within a specific Simplifier.net project.

```APIDOC
## GET /api/v3/projects/{project_urlkey}/Files

### Description
Retrieves a list of files that are contained within a specified Simplifier.net project.

### Method
GET

### Endpoint
https://api.simplifier.net/api/v3/projects/{{project_urlkey}}/Files

### Parameters
#### Path Parameters
- **project_urlkey** (string) - Required - The unique URL key of the project.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication. Format: `Bearer <access_token>`.

### Response
#### Success Response (200)
- (Array of Objects) - A list of files within the project, each with details like name and type.

#### Response Example
```json
[
  {
    "name": "resource.json",
    "type": "json"
  },
  {
    "name": "structuredefinition.xml",
    "type": "xml"
  }
]
```
```

--------------------------------

### Fetch Resource from FHIR Server

Source: https://docs.fire.ly/projects/Simplifier/_sources/getting_started/simplifierProjects

Demonstrates how to fetch resources from a FHIR server using GET requests or FHIR search queries. Supports adding single resources or multiple resources conforming to specific profiles.

```http
http://example.org/fhir/Patient/example
http://example.org/fhir/Patient?profile=http://hl7.org/fhir/StringDefinition/daf-patient
```

--------------------------------

### Perform GET Request with jQuery

Source: https://docs.fire.ly/projects/Simplifier/features/simplifierConnectors

Demonstrates using jQuery's $.get() function to fetch data from a specified URL. It includes a success callback to handle the response.

```javascript
$.get(url).success(function()
{

});

```

--------------------------------

### Bulk Java Validation Example

Source: https://docs.fire.ly/projects/Simplifier/_sources/simplifierReleaseNotes

This snippet demonstrates how to perform bulk validation using Java validator rules. It specifies the action as 'java-validate' and lists the files to be validated.

```yaml
- action: java-validate
  files: 

```

--------------------------------

### Features API: Get Project Files

Source: https://docs.fire.ly/projects/Simplifier/features/api

Retrieves a list of files within a specified Simplifier.net project.

```http
GET https://api.simplifier.net/api/v3/projects/{{project_urlkey}}/Files


```

--------------------------------

### Simplifier Read-Only Redirect Connector

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/simplifierConnectors

A basic read-only connector example that redirects the window location to a specified URL, including the resource endpoint of the current page.

```Javascript
// a simple redirect that provides the target location with the resource endpoint of the current page.
window.location.href = "https://fhir-formats.github.io/index.html?loadResource="+simplifier.ResourceEndpoint;
```

--------------------------------

### Check Canonical Base URL (YAML)

Source: https://docs.fire.ly/projects/Simplifier/data_governance_and_quality_control/simplifierQualityControl

A rule to verify if the canonical URLs of conformance resources start with a specified base URL, excluding Implementation Guides.

```yaml
- name: canonical-starts-with
  filter: url.exists() and ImplementationGuide.exists().not()
  # Excluding IGs for now, since they have a Simplifier.net canonical
  status: "Checking if canonical URL starts with correct base"
  predicate: url.startsWith('https://fhir.hl7.org.uk/')
  error-message: "Canonical URL doesn't start with correct base"

```

--------------------------------

### Create Example Connector Script (JavaScript)

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/simplifierConnectors

A basic Javascript connector script that redirects the current webpage to a specified URL, passing the resource's FHIR endpoint as a parameter. This is useful for sending resource data to external processing services.

```javascript
// trivial connector that redirects the webpage to example.com with a parameter to the resource
// the connector was used with
window.location.href = "http://example.com/createExample?profile="+simplifierServer.ResourceEndpoint+"&callbackurl="+returnUrl;
```

--------------------------------

### Example package.bake.yaml for JSON transformation

Source: https://docs.fire.ly/projects/Simplifier/data_governance_and_quality_control/simplifierPackages

This snippet demonstrates how to configure a `package.bake.yaml` file to transform all resources to JSON format. It specifies the source, category, transformation type, and target bucket for the process, adhering to FHIR package specifications.

```yaml
# Transform all resources to JSON (Mandatory according to the specification)
tranform-to-json:
  - source: input
  - category: Resource
  - tranform: json
  - target: bucket1

```

--------------------------------

### IG Editor: Tree expansion and button properties

Source: https://docs.fire.ly/projects/Simplifier/_sources/simplifierReleaseNotes

Demonstrates how to use the 'expand' property for controlling tree expansion levels and the 'buttons' property to display diff, snap, and hybrid options within an Implementation Guide.

```html
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, expand}}
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, expand: 2}}
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, buttons}}
```

--------------------------------

### Project ZIP API

Source: https://docs.fire.ly/projects/Simplifier/features/api

Provides endpoints to synchronize a complete project in zipped format. You can retrieve or update the project using GET or PUT requests.

```APIDOC
## GET/PUT /websites/fire_ly_projects_simplifier/zip

### Description
Retrieve or update a project in zipped form.

### Method
GET, PUT

### Endpoint
https://api.simplifier.net/<yourproject>/zip

### Request Example
```
GET https://api.simplifier.net/my_project/zip
```

### Response Example
```json
{
  "status": "success",
  "message": "Project zipped successfully"
}
```
```

--------------------------------

### JWT Authentication: Authorize Request (GET)

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/api

Demonstrates how to use the retrieved JWT token for API requests by including it in the 'Authorization' header as a Bearer token. This is used for accessing protected resources like project zip files.

```HTTP
GET https://api.simplifier.net/<yourproject>/zip

Header:
Authorization: Bearer <access_token>
```

--------------------------------

### Restart Firely Server (PowerShell)

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/simplifierFirely-server

These PowerShell commands are used to stop and then start the Firely Server. Restarting the server is one method to update conformance resources from the connected Simplifier project.

```PowerShell
> ./stop-firely-server.ps1
> ./start-firely-server.ps1
```

--------------------------------

### Search Structure Definitions by Description

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/api

This example demonstrates how to search for StructureDefinitions within a project that contain a specific term in their description. Replace '<searchedterm>' with your search query.

```http
GET https://stu3.simplifier.net/<yourproject>/StructureDefinition?description:contains=<searchedterm>
```

--------------------------------

### Check Canonical Base URLs (YAML)

Source: https://docs.fire.ly/projects/Simplifier/_sources/data_governance_and_quality_control/simplifierQualityControl

This rule checks if the canonical URLs for conformance resources start with a specific base URL. It includes a filter to exclude Implementation Guides and provides an error message if the condition is not met.

```yaml
- name: canonical-starts-with
  filter: url.exists() and ImplementationGuide.exists().not()
  # Excluding IGs for now, since they have a Simplifier.net canonical
  status: "Checking if canonical URL starts with correct base"
  predicate: url.startsWith('https://fhir.hl7.org.uk/')
  error-message: "Canonical URL doesn't start with correct base"
```

--------------------------------

### Retrieve or Update Project ZIP

Source: https://docs.fire.ly/projects/Simplifier/features/api

Allows synchronization of a complete project using a ZIP archive. Supports GET for retrieval and PUT for updates via the specified endpoint.

```HTTP
GET https://api.simplifier.net/<yourproject>/zip
```

```HTTP
PUT https://api.simplifier.net/<yourproject>/zip
```

--------------------------------

### Allow Unrestricted PowerShell Script Execution

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/simplifierFirely-server

Temporarily allows the execution of downloaded PowerShell scripts in the current process. This is necessary because the provided start script may not be signed.

```powershell
Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process
```

--------------------------------

### Retrieve FHIR Resource Summary

Source: https://docs.fire.ly/projects/Simplifier/features/api

Illustrates how to request a subset of a FHIR resource using the `_summary` parameter. This example retrieves a summary of StructureDefinition resources.

```HTTP
GET https://stu3.simplifier.net/<yourproject>/StructureDefinition?_summary=true
```

--------------------------------

### IG Editor: Language switching in render commands

Source: https://docs.fire.ly/projects/Simplifier/_sources/simplifierReleaseNotes

Shows how to use the 'lang' property to switch the rendering language for specific resources within an Implementation Guide, provided the language is available.

```html
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, lang: fr-BE}}
```

--------------------------------

### Features API: Get User Features (GET)

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/api

Retrieves the features a user is entitled to based on their current plan. This is a simple GET request to the 'myfeatures' endpoint.

```HTTP
GET https://api.simplifier.net/myfeatures
```

--------------------------------

### Update FHIR Resource via Fetch

Source: https://docs.fire.ly/projects/Simplifier/_sources/getting_started/simplifierResources

Enables updating FHIR resources by fetching them from a different FHIR server. Requires providing a GET request URL to the source server.

```text
Fetch: Update by fetching from a different FHIR server (provide a GET request to the server where your resource is located)
```

--------------------------------

### Resource Property Extraction with Comments

Source: https://docs.fire.ly/projects/Simplifier/getting_started/simplifierResources

Shows examples of extracting resource properties like Title, Description, and FilePath using FhirPath, including comments for better code readability. Supports both '#' and '//' for comments.

```fhirpath
#Resource examples
Observation.Title: code.text
```

```fhirpath
//Profiles
Profile.Description: <expression for your description>
```

```fhirpath
StructureDefinition.FilePath: <expression for filepath>
```

--------------------------------

### Restart Firely Server (PowerShell)

Source: https://docs.fire.ly/projects/Simplifier/features/simplifierFirely-server

These commands illustrate how to restart the Firely Server using PowerShell scripts. It includes stopping the server and then starting it again, typically after updates or configuration changes.

```PowerShell
> ./stop-firely-server.ps1
> ./start-firely-server.ps1
```

--------------------------------

### Using 'first()' for Conditional Display in Simplifier

Source: https://docs.fire.ly/projects/Simplifier/_sources/getting_started/simplifierResources

Presents an example of using the 'first()' FHIRPath function in Simplifier to select the first available display or reference value for a PractitionerRole's Title, with a fallback text.

```Simplifier/FHIRPath
PractitionerRole.Title: 'Role(s) of ' + (practitioner.display | practitioner.reference).first()
```

--------------------------------

### Tree Widget Rendering Options (diff, snap, hybrid)

Source: https://docs.fire.ly/projects/Simplifier/implementation_guide/create_your_first_ig

Demonstrates how to set the 'tree' widget to display 'diff', 'snap', or 'hybrid' renderings of a resource. These options control how changes and snapshots of the resource are presented.

```Liquid
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, diff}}
```

```Liquid
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, snap}}
```

```Liquid
{{tree:http://hl7.org/fhir/StructureDefinition/Patient, hybrid}}
```

--------------------------------

### Add Dependencies to package.json (JSON Example)

Source: https://docs.fire.ly/projects/Simplifier/data_governance_and_quality_control/simplifierPackages

This snippet demonstrates how to add package dependencies by directly editing the 'dependencies' object within a 'package.json' file. It shows the structure for specifying package names and their versions.

```json
{
  "name": "my-fhir-package",
  "version": "1.0.0",
  "dependencies": {
    "hl7.fhir.r4.core": "4.0.1",
    "fhir.us.core": "3.0.1"
  }
}
```

--------------------------------

### YAML Ruleset Structure Example

Source: https://docs.fire.ly/projects/Simplifier/_sources/data_governance_and_quality_control/simplifierQualityControl

Defines the basic structure of a YAML rules file, showing how entries are defined with key-value pairs and comments. This format is used for configuring quality control checks.

```yaml
# comment for first entry

- first: value
  second: value
  third: value

# comment for second entry

- first: value
  second: value
  third: value
```

--------------------------------

### Synchronize Project Down with Firely Terminal

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/simplifierBackupAndSynchronization

This command-line instruction uses the Firely Terminal client tool to synchronize (download) a Simplifier project. Firely Terminal utilizes the Simplifier ZIP API and is designed for CI/CD integration. Ensure Firely Terminal is installed and configured to use this command.

```bash
fhir sync <projectname> -down
```

--------------------------------

### Render Page Content within Another Page in Simplifier

Source: https://docs.fire.ly/projects/Simplifier/simplifierReleaseNotes

Introduces the `{{page:...}}` placeholder in Simplifier, allowing the content of one page to be rendered within another. This feature respects the current context, enabling dynamic content inclusion and better organization of guide pages.

```simplifier
{{page:PageName}}
```

--------------------------------

### Create Internal Page Link using URL Key

Source: https://docs.fire.ly/projects/Simplifier/implementation_guide/create_your_first_ig

Generates a link to another page within the Implementation Guide using a URL key. The URL key can be found via autocomplete or the address bar of the resource page. Changing the URL key of the linked page or its parent folder may break the link.

```Wiki Markup
{{pagelink:<url key for the markdown resource describing the page>}}
```

--------------------------------

### Add Breadcrumbs to Simplifier IG Pages

Source: https://docs.fire.ly/projects/Simplifier/simplifierReleaseNotes

Shows how to implement breadcrumb trails in Simplifier Implementation Guides (IGs) using the `{{breadcrumbs}}` placeholder. This placeholder should be added to the master template to display the hierarchical navigation of IG pages, enhancing user experience.

```simplifier
{{breadcrumbs}}
```

--------------------------------

### Features API: Get Project Files (GET)

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/api

Retrieves a list of files contained within a specific Simplifier.net project. The project's URL key is used in the endpoint path.

```HTTP
GET https://api.simplifier.net/api/v3/projects/{{project_urlkey}}/Files
```

--------------------------------

### Snippet Resource Actions (View, Edit, Clone, Download, Validate)

Source: https://docs.fire.ly/projects/Simplifier/_sources/getting_started/simplifierResources

Describes the actions available when viewing a Snippet URL, including viewing XML/JSON code, editing, cloning, downloading, and validating the resource.

```text
When visiting the URL of a Snippet, you can choose to view either the XML code, JSON code or the rendered resource by selecting one of the available tabs. In the top right menu you can either select ``Edit`` to edit the resource, ``Clone`` to copy it in a new Snippet, ``New`` to create a new Snippet or ``Download`` to download the resource as a XML or JSON file. You can also validate the resource by using the green ``Validate`` button at the right.
```

--------------------------------

### Simplifier IG Index Generation Statements

Source: https://docs.fire.ly/projects/Simplifier/_sources/implementation_guide/create_your_first_ig

These statements are used within the Simplifier IG editor to generate indices within the guide. They help in creating navigation elements for the entire IG or specific sections.

```Simplifier Template
{{index:root}}

```

```Simplifier Template
{{index:current}}

```

--------------------------------

### GET /websites/fire_ly_projects_simplifier/StructureDefinition?_summary=true

Source: https://docs.fire.ly/projects/Simplifier/_sources/features/api

Retrieves a summary of StructureDefinitions within the specified project.

```APIDOC
## GET /websites/fire_ly_projects_simplifier/StructureDefinition?_summary=true

### Description
Retrieves a summary of StructureDefinitions within the specified project. This typically returns a subset of fields for each StructureDefinition.

### Method
GET

### Endpoint
https://stu3.simplifier.net/<yourproject>/StructureDefinition

### Parameters
#### Path Parameters
- **yourproject** (string) - Required - The identifier for your project.

#### Query Parameters
- **_summary** (boolean) - Required - When true, returns a summary, rather than the full resource.

### Response
#### Success Response (200)
- **Bundle** (object) - A FHIR Bundle resource containing a summary list of StructureDefinition resources.

#### Response Example
```json
{
  "resourceType": "Bundle",
  "entry": [
    {
      "resource": {
        "resourceType": "StructureDefinition",
        "id": "example-structure-summary-1",
        "url": "http://example.org/StructureDefinition/example-1"
      }
    }
  ]
}
```
```
Tokens:
Raw