API Example Documentation Templates and Rules

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "coverage",
      "valueReference": {
        "reference": "Coverage/coverage-123",
        "type": "Coverage",
        "display": "Member coverage"
      }
    },
    {
      "name": "order",
      "valueReference": {
        "reference": "ServiceRequest/order-456",
        "type": "ServiceRequest",
        "display": "Requested service"
      }
    }
  ]
  }
{
	"resourceType": "Bundle",
	"type": "searchset",
	"total": 3,
	"entry": [
		{
			"fullUrl": "http://payer.example.com/fhir/Questionnaire/prior-auth-home-o2",
			"resource": {
				"resourceType": "Questionnaire",
				"id": "prior-auth-home-o2",
				"url": "http://payer.example.com/fhir/Questionnaire/prior-auth-home-o2",
				"version": "1.0.0",
				"title": "Home Oxygen Therapy — Prior Authorization Questionnaire",
				"status": "active",
				"subjectType": [
					"Patient"
				],
				"item": [
					{
						"linkId": "group-1",
						"text": "Patient & Order Information",
						"type": "group",
						"item": [
							{
								"linkId": "1.1",
								"text": "Primary Diagnosis Code",
								"type": "open-choice",
								"required": true,
								"answerValueSet": "http://payer.example.com/fhir/ValueSet/resp-dx-codes"
							},
							{
								"linkId": "1.2",
								"text": "Ordering Physician NPI",
								"type": "string",
								"required": true
							}
						]
					},
					{
						"linkId": "group-2",
						"text": "Home Oxygen Therapy Details",
						"type": "group",
						"item": [
							{
								"linkId": "2.1",
								"text": "Oxygen flow rate (LPM)",
								"type": "decimal",
								"required": true
							},
							{
								"linkId": "2.2",
								"text": "Prescribed hours per day",
								"type": "integer",
								"required": true
							},
							{
								"linkId": "2.3",
								"text": "Qualifying test result: arterial blood O2 saturation (%)",
								"type": "decimal",
								"required": true
							},
							{
								"linkId": "2.4",
								"text": "Attending physician attestation: patient meets LCD criteria",
								"type": "boolean",
								"required": true
							}
						]
					}
				]
			}
		},
		{
			"fullUrl": "http://payer.example.com/fhir/Library/home-o2-cql-lib",
			"resource": {
				"resourceType": "Library",
				"id": "home-o2-cql-lib",
				"url": "http://payer.example.com/fhir/Library/home-o2-cql-lib",
				"version": "1.0.0",
				"name": "HomeO2PriorAuth",
				"title": "Home Oxygen Therapy Prior Authorization CQL Library",
				"status": "active",
				"type": {
					"coding": [
						{
							"system": "http://terminology.hl7.org/CodeSystem/library-type",
							"code": "logic-library"
						}
					]
				},
				"content": [
					{
						"contentType": "text/cql",
						"title": "HomeO2PriorAuth.cql",
						"data": "bGlicmFyeSBIb21lTzJQcmlvckF1dGggdmVyc2lvbiAnMS4wLjAnCnVzaW5nIEZISVIgdmVyc2lvbiAnNC4wLjEnCmluY2x1ZGUgRkhJUkhlbHBlcnMgdmVyc2lvbiAnNC4wLjEnCgpjb250ZXh0IFBhdGllbnQKCmRlZmluZSBPcmRlcmluZ1BoeXNpY2lhbk5QSToKICBGaGlyLnN0cmluZygnMTIzNDU2Nzg5MCcp"
					},
					{
						"contentType": "application/elm+json",
						"title": "HomeO2PriorAuth.elm.json",
						"data": "eyJsaWJyYXJ5Ijp7ImlkZW50aWZpZXIiOnsiaWQiOiJIb21lTzJQcmlvckF1dGgiLCJ2ZXJzaW9uIjoiMS4wLjAifX19"
					}
				]
			}
		},
		{
			"fullUrl": "http://payer.example.com/fhir/ValueSet/resp-dx-codes",
			"resource": {
				"resourceType": "ValueSet",
				"id": "resp-dx-codes",
				"url": "http://payer.example.com/fhir/ValueSet/resp-dx-codes",
				"version": "2026-01",
				"title": "Respiratory Diagnosis Codes (ICD-10-CM)",
				"status": "active",
				"compose": {
					"include": [
						{
							"system": "http://hl7.org/fhir/sid/icd-10-cm",
							"concept": [
								{
									"code": "J96.10",
									"display": "Chronic respiratory failure, unspecified"
								},
								{
									"code": "J96.11",
									"display": "Chronic respiratory failure with hypoxia"
								},
								{
									"code": "J44.1",
									"display": "COPD with acute exacerbation"
								},
								{
									"code": "J45.51",
									"display": "Severe persistent asthma with acute exacerbation"
								}
							]
						}
					]
				}
			}
		}
	]
}

Did this page help you?