Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CodeSystem/restful-security-service (JSON)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Definition for Code SystemRestfulSecurityService

{
  "resourceType" : "CodeSystem",
  "id" : "restful-security-service",
  "meta" : {
    "lastUpdated" : "2023-03-26T15:21:02.749+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system <code>http://hl7.org/fhir/restful-security-service</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">OAuth<a name=\"restful-security-service-OAuth\"> </a></td><td>OAuth (unspecified version see oauth.net).</td></tr><tr><td style=\"white-space:nowrap\">SMART-on-FHIR<a name=\"restful-security-service-SMART-on-FHIR\"> </a></td><td>OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org/).</td></tr><tr><td style=\"white-space:nowrap\">NTLM<a name=\"restful-security-service-NTLM\"> </a></td><td>Microsoft NTLM Authentication.</td></tr><tr><td style=\"white-space:nowrap\">Basic<a name=\"restful-security-service-Basic\"> </a></td><td>Basic authentication defined in HTTP specification.</td></tr><tr><td style=\"white-space:nowrap\">Kerberos<a name=\"restful-security-service-Kerberos\"> </a></td><td>see http://www.ietf.org/rfc/rfc4120.txt.</td></tr><tr><td style=\"white-space:nowrap\">Certificates<a name=\"restful-security-service-Certificates\"> </a></td><td>SSL where client must have a certificate registered with the server.</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "normative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
    "valueCode" : "4.0.0"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 5
  }],
  "url" : "http://hl7.org/fhir/restful-security-service",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.1079"
  }],
  "version" : "5.0.0",
  "name" : "RestfulSecurityService",
  "title" : "Restful Security Service",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-12-28T16:55:11+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "Types of security services used with FHIR.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/restful-security-service",
  "content" : "complete",
  "concept" : [{
    "code" : "OAuth",
    "display" : "OAuth",
    "definition" : "OAuth (unspecified version see oauth.net)."
  },
  {
    "code" : "SMART-on-FHIR",
    "display" : "SMART-on-FHIR",
    "definition" : "OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org/)."
  },
  {
    "code" : "NTLM",
    "display" : "NTLM",
    "definition" : "Microsoft NTLM Authentication."
  },
  {
    "code" : "Basic",
    "display" : "Basic",
    "definition" : "Basic authentication defined in HTTP specification."
  },
  {
    "code" : "Kerberos",
    "display" : "Kerberos",
    "definition" : "see http://www.ietf.org/rfc/rfc4120.txt."
  },
  {
    "code" : "Certificates",
    "display" : "Certificates",
    "definition" : "SSL where client must have a certificate registered with the server."
  }]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.