{"schemaVersion":"1.0","id":"residency-reality","name":"Orientation review","description":"A personal nursing orientation brief with applicable employer findings, one to three priority questions, an editable inquiry, and the sources used.","audience":["RN","LPN","LVN","NP"],"url":"https://www.nursingmastery.com/tools/residency-reality","execution":{"method":"POST","url":"https://www.nursingmastery.com/api/residency-orientation-check","headers":{"Content-Type":"application/json","Origin":"https://www.nursingmastery.com"},"requestBody":{"inputs":"An object matching inputsSchema; role pn means LPN or LVN.","previous":"Optional complete residency-reality artifact for an explicit revision; reopening an unchanged saved brief needs no generation request."},"responseBody":"{ok:true,artifact:{toolKey:'residency-reality',version:1,inputs,result}}","timeoutSeconds":123,"access":"No account required. POST requires application/json and a matching same-origin Origin; the public GET reference is cross-origin readable.","maximumRequestBytes":65536,"rateLimit":"Six requests per ten minutes per visitor instance; 429 includes Retry-After.","fallback":"A new brief may return 200 with result.guidance.generationMode='fallback'. An unsuccessful revision returns 503 without replacing the previous artifact. Invalid input or a malformed previous artifact returns 400; a cancelled request returns 499."},"inputsSchema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"role":{"type":"string","enum":["rn","pn","np"]},"orientationWeeks":{"anyOf":[{"type":"number","minimum":0,"maximum":100000000},{"type":"string","const":""}]},"consistentPreceptor":{"type":"string","enum":["yes","no","unknown"]},"extensionPolicy":{"type":"string","enum":["yes","no","unknown"]},"protectedEducation":{"type":"string","enum":["yes","no","unknown"]},"ratiosDiscussed":{"type":"string","enum":["yes","no","unknown"]},"turnoverShared":{"type":"string","enum":["yes","no","unknown"]},"accreditation":{"type":"string","enum":["yes","no","unknown"]},"commitmentMonths":{"type":"number","minimum":0,"maximum":100000000},"repaymentAmount":{"type":"number","minimum":0,"maximum":100000000},"setting":{"type":"string","maxLength":200},"shift":{"type":"string","maxLength":100},"stage":{"type":"string","enum":["considering","accepted","started"]},"priority":{"type":"string","enum":["training","support","expectations","terms","unsure"]},"workplace":{"type":"object","properties":{"name":{"type":"string","maxLength":200},"campus":{"type":"string","maxLength":200},"url":{"anyOf":[{"const":""},{"type":"string","format":"uri","maxLength":2000,"pattern":"^[Hh][Tt][Tt][Pp][Ss]://"}],"description":"An empty string when no link is supplied; otherwise a public HTTPS URL using the default HTTPS port or port 443. The execution endpoint rejects credentials, IP-address hosts, single-label hosts, and private or internal destinations. URL fragments are removed before research."},"slug":{"type":"string","maxLength":160,"pattern":"^(?:[a-z0-9]+(?:-[a-z0-9]+)*)?$"}},"required":["name","campus","url"],"additionalProperties":false},"notes":{"type":"string","maxLength":1200},"programType":{"type":"string","enum":["orientation","residency","fellowship","unsure"]},"programDuration":{"type":"object","properties":{"value":{"type":"number","minimum":0,"maximum":1200},"unit":{"type":"string","enum":["weeks","months"]}},"required":["value","unit"],"additionalProperties":false},"programDurationStatus":{"type":"string","enum":["unknown","stated","not-applicable"]},"orientationStatus":{"type":"string","enum":["unknown","stated","not-applicable"]},"orientationBasis":{"type":"string","enum":["written","discussed","unknown"]},"commitmentStatus":{"type":"string","enum":["unknown","stated","not-applicable"]},"repaymentStatus":{"type":"string","enum":["unknown","stated","not-applicable"]}},"required":["role","orientationWeeks","consistentPreceptor","extensionPolicy","protectedEducation","ratiosDiscussed","turnoverShared","accreditation","commitmentMonths","repaymentAmount"],"additionalProperties":false,"allOf":[{"if":{"required":["orientationStatus"],"properties":{"orientationStatus":{"enum":["unknown","not-applicable"]}}},"then":{"properties":{"orientationWeeks":{"enum":[0,""]}}}},{"if":{"required":["commitmentStatus"],"properties":{"commitmentStatus":{"enum":["unknown","not-applicable"]}}},"then":{"properties":{"commitmentMonths":{"const":0}}}},{"if":{"required":["repaymentStatus"],"properties":{"repaymentStatus":{"enum":["unknown","not-applicable"]}}},"then":{"properties":{"repaymentAmount":{"const":0}}}},{"if":{"required":["orientationStatus"],"properties":{"orientationStatus":{"const":"stated"}}},"then":{"properties":{"orientationWeeks":{"type":"number"}}}},{"if":{"required":["programDurationStatus"],"properties":{"programDurationStatus":{"const":"stated"}}},"then":{"required":["programDuration"]}},{"if":{"required":["programDurationStatus"],"properties":{"programDurationStatus":{"enum":["unknown","not-applicable"]}}},"then":{"not":{"required":["programDuration"]}}}]},"resultSchema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"role":{"type":"string","enum":["rn","pn","np"]},"state":{"type":"string","enum":["slow-down","get-it-in-writing","ready-to-compare"]},"strengths":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":2000}},"unknowns":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":2000}},"watchouts":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":2000}},"questions":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":2000}},"orientationWeeks":{"type":"number","minimum":0,"maximum":100000000},"commitmentMonths":{"type":"number","minimum":0,"maximum":100000000},"repaymentAmount":{"type":"number","minimum":0,"maximum":100000000},"guidance":{"type":"object","properties":{"schemaVersion":{"type":"number","const":1},"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"generationMode":{"type":"string","enum":["ai","fallback"]},"generatedFor":{"type":"string","minLength":1,"maxLength":20000},"researchStatus":{"type":"string","enum":["not-requested","found","needs-confirmation","not-found","unavailable"]},"content":{"type":"object","properties":{"headline":{"type":"string","minLength":1,"maxLength":120,"pattern":"\\S"},"summary":{"type":"string","minLength":1,"maxLength":500,"pattern":"\\S"},"employerFindings":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"title":{"type":"string","minLength":1,"maxLength":90,"pattern":"\\S"},"detail":{"type":"string","minLength":1,"maxLength":500,"pattern":"\\S"},"applicability":{"type":"string","enum":["this-role","general-program","unconfirmed"]},"evidenceIds":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"}}},"required":["id","title","detail","applicability","evidenceIds"],"additionalProperties":false}},"clarifications":{"minItems":1,"maxItems":3,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"question":{"type":"string","minLength":1,"maxLength":500,"pattern":"\\S"},"whyItMatters":{"type":"string","minLength":1,"maxLength":400,"pattern":"\\S"},"listenFor":{"type":"string","minLength":1,"maxLength":500,"pattern":"\\S"},"evidenceIds":{"maxItems":4,"type":"array","items":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"}}},"required":["id","question","whyItMatters","listenFor","evidenceIds"],"additionalProperties":false}},"inquiry":{"type":"object","properties":{"recipient":{"type":"string","minLength":1,"maxLength":120,"pattern":"\\S"},"body":{"type":"string","minLength":1,"maxLength":2000,"pattern":"\\S"},"evidenceIds":{"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"}}},"required":["recipient","body","evidenceIds"],"additionalProperties":false}},"required":["headline","summary","employerFindings","clarifications","inquiry"],"additionalProperties":false},"evidence":{"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"statement":{"type":"string","minLength":1,"maxLength":800,"pattern":"\\S"},"sourceId":{"anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},{"type":"null"}]},"origin":{"type":"string","enum":["user","employer","reference"]},"applicability":{"type":"string","enum":["this-role","general-program","unconfirmed"]}},"required":["id","statement","sourceId","origin","applicability"],"additionalProperties":false}},"sources":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"title":{"type":"string","minLength":1,"maxLength":200,"pattern":"\\S"},"url":{"type":"string","maxLength":2000,"format":"uri"},"retrievedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"scope":{"type":"string","minLength":1,"maxLength":400,"pattern":"\\S"}},"required":["id","title","url","retrievedAt","scope"],"additionalProperties":false}}},"required":["schemaVersion","id","generatedAt","generationMode","generatedFor","researchStatus","content","evidence","sources"],"additionalProperties":false}},"required":["role","state","strengths","unknowns","watchouts","questions","orientationWeeks","commitmentMonths","repaymentAmount"],"additionalProperties":false},"artifactSchema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"toolKey":{"type":"string","const":"residency-reality"},"version":{"type":"number","const":1},"inputs":{"type":"object","properties":{"role":{"type":"string","enum":["rn","pn","np"]},"orientationWeeks":{"anyOf":[{"type":"number","minimum":0,"maximum":100000000},{"type":"string","const":""}]},"consistentPreceptor":{"type":"string","enum":["yes","no","unknown"]},"extensionPolicy":{"type":"string","enum":["yes","no","unknown"]},"protectedEducation":{"type":"string","enum":["yes","no","unknown"]},"ratiosDiscussed":{"type":"string","enum":["yes","no","unknown"]},"turnoverShared":{"type":"string","enum":["yes","no","unknown"]},"accreditation":{"type":"string","enum":["yes","no","unknown"]},"commitmentMonths":{"type":"number","minimum":0,"maximum":100000000},"repaymentAmount":{"type":"number","minimum":0,"maximum":100000000},"setting":{"type":"string","maxLength":200},"shift":{"type":"string","maxLength":100},"stage":{"type":"string","enum":["considering","accepted","started"]},"priority":{"type":"string","enum":["training","support","expectations","terms","unsure"]},"workplace":{"type":"object","properties":{"name":{"type":"string","maxLength":200},"campus":{"type":"string","maxLength":200},"url":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"string","const":""}]},"slug":{"type":"string","maxLength":160,"pattern":"^(?:[a-z0-9]+(?:-[a-z0-9]+)*)?$"}},"required":["name","campus","url"],"additionalProperties":false},"notes":{"type":"string","maxLength":1200},"programType":{"type":"string","enum":["orientation","residency","fellowship","unsure"]},"programDuration":{"type":"object","properties":{"value":{"type":"number","minimum":0,"maximum":1200},"unit":{"type":"string","enum":["weeks","months"]}},"required":["value","unit"],"additionalProperties":false},"programDurationStatus":{"type":"string","enum":["unknown","stated","not-applicable"]},"orientationStatus":{"type":"string","enum":["unknown","stated","not-applicable"]},"orientationBasis":{"type":"string","enum":["written","discussed","unknown"]},"commitmentStatus":{"type":"string","enum":["unknown","stated","not-applicable"]},"repaymentStatus":{"type":"string","enum":["unknown","stated","not-applicable"]}},"required":["role","orientationWeeks","consistentPreceptor","extensionPolicy","protectedEducation","ratiosDiscussed","turnoverShared","accreditation","commitmentMonths","repaymentAmount"],"additionalProperties":false},"result":{"type":"object","properties":{"role":{"type":"string","enum":["rn","pn","np"]},"state":{"type":"string","enum":["slow-down","get-it-in-writing","ready-to-compare"]},"strengths":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":2000}},"unknowns":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":2000}},"watchouts":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":2000}},"questions":{"maxItems":40,"type":"array","items":{"type":"string","maxLength":2000}},"orientationWeeks":{"type":"number","minimum":0,"maximum":100000000},"commitmentMonths":{"type":"number","minimum":0,"maximum":100000000},"repaymentAmount":{"type":"number","minimum":0,"maximum":100000000},"guidance":{"type":"object","properties":{"schemaVersion":{"type":"number","const":1},"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"generationMode":{"type":"string","enum":["ai","fallback"]},"generatedFor":{"type":"string","minLength":1,"maxLength":20000},"researchStatus":{"type":"string","enum":["not-requested","found","needs-confirmation","not-found","unavailable"]},"content":{"type":"object","properties":{"headline":{"type":"string","minLength":1,"maxLength":120,"pattern":"\\S"},"summary":{"type":"string","minLength":1,"maxLength":500,"pattern":"\\S"},"employerFindings":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"title":{"type":"string","minLength":1,"maxLength":90,"pattern":"\\S"},"detail":{"type":"string","minLength":1,"maxLength":500,"pattern":"\\S"},"applicability":{"type":"string","enum":["this-role","general-program","unconfirmed"]},"evidenceIds":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"}}},"required":["id","title","detail","applicability","evidenceIds"],"additionalProperties":false}},"clarifications":{"minItems":1,"maxItems":3,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"question":{"type":"string","minLength":1,"maxLength":500,"pattern":"\\S"},"whyItMatters":{"type":"string","minLength":1,"maxLength":400,"pattern":"\\S"},"listenFor":{"type":"string","minLength":1,"maxLength":500,"pattern":"\\S"},"evidenceIds":{"maxItems":4,"type":"array","items":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"}}},"required":["id","question","whyItMatters","listenFor","evidenceIds"],"additionalProperties":false}},"inquiry":{"type":"object","properties":{"recipient":{"type":"string","minLength":1,"maxLength":120,"pattern":"\\S"},"body":{"type":"string","minLength":1,"maxLength":2000,"pattern":"\\S"},"evidenceIds":{"maxItems":8,"type":"array","items":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"}}},"required":["recipient","body","evidenceIds"],"additionalProperties":false}},"required":["headline","summary","employerFindings","clarifications","inquiry"],"additionalProperties":false},"evidence":{"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"statement":{"type":"string","minLength":1,"maxLength":800,"pattern":"\\S"},"sourceId":{"anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},{"type":"null"}]},"origin":{"type":"string","enum":["user","employer","reference"]},"applicability":{"type":"string","enum":["this-role","general-program","unconfirmed"]}},"required":["id","statement","sourceId","origin","applicability"],"additionalProperties":false}},"sources":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$"},"title":{"type":"string","minLength":1,"maxLength":200,"pattern":"\\S"},"url":{"type":"string","maxLength":2000,"format":"uri"},"retrievedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"scope":{"type":"string","minLength":1,"maxLength":400,"pattern":"\\S"}},"required":["id","title","url","retrievedAt","scope"],"additionalProperties":false}}},"required":["schemaVersion","id","generatedAt","generationMode","generatedFor","researchStatus","content","evidence","sources"],"additionalProperties":false}},"required":["role","state","strengths","unknowns","watchouts","questions","orientationWeeks","commitmentMonths","repaymentAmount"],"additionalProperties":false}},"required":["toolKey","version","inputs","result"],"additionalProperties":false},"exampleRequest":{"inputs":{"role":"pn","stage":"considering","orientationWeeks":"","consistentPreceptor":"unknown","extensionPolicy":"unknown","protectedEducation":"unknown","ratiosDiscussed":"unknown","turnoverShared":"unknown","accreditation":"unknown","commitmentMonths":0,"repaymentAmount":0,"orientationStatus":"unknown","commitmentStatus":"unknown","repaymentStatus":"unknown"}},"inputMeaning":{"orientationWeeks":"Time in supervised orientation; separate from the total residency or fellowship duration.","programDuration":"Total program length with an explicit weeks or months unit. Omit when unknown or not applicable.","termStatus":"Use the optional status fields to distinguish unknown, stated zero, and not applicable. A zero without a stated status does not establish that a fee or work commitment is absent.","orientationBasis":"Whether the nurse describes the orientation term as written, discussed, or unknown; this does not independently verify an offer.","workplace":"Employer, campus and public program or job URL. These identify what to research; they do not establish enrollment or personal arrangements."},"sourcePolicy":"Published findings link to included sources, retrieval dates and evidence IDs. Applicability is this-role, general-program or unconfirmed. Nurse-supplied details remain distinct from published employer terms. Missing information does not imply poor support or program quality.","resultMeaning":"Read result.guidance.content for the personal brief, result.guidance.researchStatus for research availability, and result.guidance.generationMode for AI or fallback. Legacy result arrays and state remain for saved-report compatibility and are not an employer quality score. The server also validates evidence references, their scope and the artifact’s exact input identity.","save":"The nurse can keep the complete artifact and edited inquiry in Saved work. Saving a report is separate from changing profile answers; reopening it preserves the saved wording and sources."}