Difference between revisions of "FHIR URIs"

(Created page with "==Prerequisites== * Your server is set up and configured as [http://hl7.org/fhir FHIR®] server. See ART_maintenance_manual#FHIR_endpoint_prefix|ART_m...")
 
(Prerequisites)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
==Prerequisites==
 
==Prerequisites==
  
* Your server is [[FHIR_Server_Setup|set up]] and configured as [http://hl7.org/fhir FHIR®] server. See [[ART_maintenance_manual#FHIR_endpoint_prefix|ART_maintenance_manual]]
+
* Your server is [[FHIR_Server_Setup|set up]] and configured as an [http://hl7.org/fhir HL7® FHIR®] server. See [[ART_maintenance_manual#FHIR_endpoint_prefix|ART_maintenance_manual]]
  
 
==Capabilities==
 
==Capabilities==
Line 7: Line 7:
 
*Retrieve DECOR value sets as [http://hl7.org/fhir/valueset.html FHIR ValueSets]
 
*Retrieve DECOR value sets as [http://hl7.org/fhir/valueset.html FHIR ValueSets]
 
*Retrieve OID Registry info as [http://hl7.org/fhir/namingsystem.html FHIR NamingSystem]
 
*Retrieve OID Registry info as [http://hl7.org/fhir/namingsystem.html FHIR NamingSystem]
 +
 +
==Examples==
 +
{|class="artdecorwiki"
 +
! URL/Description
 +
|-
 +
| http://art-decor.org/fhir/3.0/hl7org/NamingSystem/2.16.840.1.113883.6.96
 +
 +
Get the naming system for SNOMED CT from the HL7 OID Registry
 +
|-
 +
| http://art-decor.org/fhir/3.0/public/StructureDefinition/2.16.840.1.113883.3.1937.99.62.3.1.1--20120530113236
 +
 +
Get the logical model for the object from any live DECOR project that has it.  Any dataset or transaction will work, in this case the demo1- dataset
 +
|-
 +
| http://art-decor.org/fhir/3.0/demo1-/ValueSet/2.16.840.1.113883.3.1937.99.62.3.11.5--20110725152256
 +
 +
Get value set with id 2.16.840.1.113883.3.1937.99.62.3.11.5 and version 2011-07-25T15:22:56 from the live DECOR demo1- project
 +
|-
 +
| http://art-decor.org/fhir/3.0/demo1-20151105100336/ValueSet/2.16.840.1.113883.3.1937.99.62.3.11.5--20110725152256
 +
 +
Get value set with id 2.16.840.1.113883.3.1937.99.62.3.11.5 and version 2011-07-25T15:22:56 from the DECOR demo1- project release 2015-11-05T10:03:36
 +
|-
 +
| http://art-decor.org/fhir/3.0/public/ValueSet/2.16.840.1.113883.3.1937.99.62.3.11.5--20110725152256
 +
 +
Get value set with id 2.16.840.1.113883.3.1937.99.62.3.11.5 and version 2011-07-25T15:22:56 from any live DECOR that carries it
 +
|-
 +
|}
  
 
==URI Patterns==
 
==URI Patterns==
Line 16: Line 42:
 
| <nowiki>[</nowiki>base<nowiki>]</nowiki>
 
| <nowiki>[</nowiki>base<nowiki>]</nowiki>
 
|-
 
|-
| [http://art-decor.org/fhir/dstu2 dstu2] or [http://art-decor.org/fhir/stu3 stu3]
+
| [http://art-decor.org/fhir/1.0 1.0] (dstu2) or [http://art-decor.org/fhir/3.0 3.0] (stu3)
 
| FHIR Version
 
| FHIR Version
 
|-
 
|-

Latest revision as of 20:34, 22 May 2018

Prerequisites

Capabilities

Examples

URL/Description
http://art-decor.org/fhir/3.0/hl7org/NamingSystem/2.16.840.1.113883.6.96

Get the naming system for SNOMED CT from the HL7 OID Registry

http://art-decor.org/fhir/3.0/public/StructureDefinition/2.16.840.1.113883.3.1937.99.62.3.1.1--20120530113236

Get the logical model for the object from any live DECOR project that has it. Any dataset or transaction will work, in this case the demo1- dataset

http://art-decor.org/fhir/3.0/demo1-/ValueSet/2.16.840.1.113883.3.1937.99.62.3.11.5--20110725152256

Get value set with id 2.16.840.1.113883.3.1937.99.62.3.11.5 and version 2011-07-25T15:22:56 from the live DECOR demo1- project

http://art-decor.org/fhir/3.0/demo1-20151105100336/ValueSet/2.16.840.1.113883.3.1937.99.62.3.11.5--20110725152256

Get value set with id 2.16.840.1.113883.3.1937.99.62.3.11.5 and version 2011-07-25T15:22:56 from the DECOR demo1- project release 2015-11-05T10:03:36

http://art-decor.org/fhir/3.0/public/ValueSet/2.16.840.1.113883.3.1937.99.62.3.11.5--20110725152256

Get value set with id 2.16.840.1.113883.3.1937.99.62.3.11.5 and version 2011-07-25T15:22:56 from any live DECOR that carries it

URI Patterns

Item Description
http://art-decor.org/fhir/ [base]
1.0 (dstu2) or 3.0 (stu3) FHIR Version
  • public
  • project prefix, e.g. demo1-
  • project prefix + release version as digits, e.g. demo1-20151105100336
  • OID Registry name, e.g. hl7org
public tries to find the requested resource anywhere on the server
Project prefix limits scope to the requested DECOR project
Project prefix + release version limits scope to the requested DECOR project release
OID Registry name limits scope to the requested OID Registry
resource The [resource] you would like to retrieve, e.g. StructureDefinition, ValueSet, NamingSystem
id The id for the resource you would like to retrieve. For NamingSystem, just use the OID. For other DECOR objects, use the id--effectiveDate where you strip non-digits from the effectiveDate