Technical Writer 0406-0716
Technical Writer 0406-0716
Posted on :
03-10-2025
Employer Active
1 Vacancy
Job Alert
You will be updated with latest job alerts via emailValid email field required
Send jobs
Share
Send me jobs like this
Job Alert
You will be updated with latest job alerts via emailValid email field required
Send jobs
Job Description
HM Note: This hybrid contract role is three (3) days in office. Candidates resumes must include first and last name.
Description
Background Information
Ontario Health is developing the HALO (Health Application Lightweight Protocol) framework a next-generation standard to enable seamless discovery and launch of third-party applications within Electronic Medical Record (EMR) systems across Ontario. A critical component for the successful adoption of HALO is a comprehensive clear and standardized integration Guide. This guide will provide the critical technical specifications and implementation procedures required to achieve interoperability and compliance with standards like CA Core Fast Healthcare Interoperability Resources (FHIR) profiles and Substitutable Medical Applications and Reusable Technologies (SMART) on FHIR.
To develop this essential documentation we are seeking a Senior Technical Writer with proven experience in healthcare IT and Application Programming Interface (API) documentation.
Must haves:
- A minimum of seven (7) years of continuous experience in creating technical documentation for complex software integrations Application Programming Interface (API) specifications or system implementation guides.
- Demonstrated ability to capture complex technical input from architects and developers and translate it into clear structured and user-friendly documentation for a technical audience.
- Proficiency and nbsp;with and nbsp;diagramming and nbsp;tools and nbsp;for and nbsp;creating and nbsp;workflow and nbsp;visuals and nbsp;(e.g. and nbsp; and nbsp;Lucid and nbsp;chart and nbsp;Visio).
- Excellent verbal and written communication skills with proven ability to collaborate effectively with technical teams and stakeholders.
Responsibilities:
- The Technical Writer will be responsible for the following key activities:
- Collaborating closely with HALO project architects developers and product owners to gather technical details and requirements.
- Authoring structuring and maintaining the comprehensive HALO Integration Guide.
- Creating clear visual aids such as sequence diagrams and architecture overviews to enhance technical understanding.
- Applying and ensuring consistency with Ontario Healths documentation standards branding and AODA accessibility guidelines.
- Managing version control and maintaining all documentation within the designated repository.
- Developing supplemental materials to support vendor onboarding and implementation
Desired Skills:
- A solid technical background with hands-on understanding of RESTful APIs OAuth 2.0/OIDC pub/sub and cloud-based architectures.
- Proven practical experience with healthcare data standards specifically FHIR (Fast Healthcare Interoperability Resources) and SMART on FHIR.
- Familiarity with FHIR profiles and FHIR Implementation Guide.
- Experience documenting systems deployed on Amazon Web Services (AWS).
- Knowledge of EMR systems and clinical workflow integration patterns.
- Understanding of privacy legislation (PHIPA) as it applies to healthcare IT solutions.
- Experience with documentation platforms like GitHub or Confluence.
Required Skills:
- API Fundamentals (Rest HTTP Methods)
- Integration Concepts
- JSON YAML Postman Confluence
Required Experience / Evaluation Criteria: and nbsp;
- 7 years of experience creating comprehensive technical documentation for software integrations API specifications or system implementation guides: 35 points
- Proven ability to capture complex technical input from subject matter experts and translate it into clear documentation for a developer audience: 25 points
- Demonstrated experience working with APIs and OAuth/OIDC service: 15 points
- Demonstrated experience and knowledge of healthcare data standards specifically FHIR and SMART on FHIR: 5 points
- Proficiency and nbsp;with and nbsp;diagramming and nbsp;tools and nbsp;(e.g. and nbsp; and nbsp;Lucidchart) and nbsp;to and nbsp;create and nbsp;effective and nbsp;workflow and nbsp;and and nbsp;architecture and nbsp;visuals: and nbsp;10 and nbsp;points
- Excellent verbal and written communication skills with demonstrated ability to collaborate effectively with technical teams and adapt to changing requirements: 10 points
Total evaluation criteria: 100 points
Deliverables
Deliverables Include but not limited to:
- The Senior Technical Writer will be accountable for the following milestone-based deliverables:
- Deliverable 1: Initial Draft Integration Guide: Complete first version within 4 weeks of start date covering architecture API specifications app launch sequences and conformance checklists with initial visual aids.
- Deliverable 2: Final Release-Ready Integration Guide: Polished comprehensive guide incorporating feedback and fully compliant with Ontario Health standards with finalized visuals and reference materials.
- Deliverable 3: Ongoing Revisions and Enhancements: Timely updates to the guide to reflect project enhancements technical changes and vendor feedback.
- Deliverable 4: Supporting Materials (As Required): Develop supplemental materials to accelerate vendor understanding such as an onboarding presentation deck an FAQ document and a glossary of key terms based on input from subject matter experts.
Knowledge Transfer Details:
- The resource will ensure full knowledge transfer is provided to the Ontario Health team before end of engagement. Some of this might occur at the end of the engagement but will also be shared as information is obtained/consolidated. Key deliverables will be shared with team.
- The resource must provide all related documentation as part of knowledge transfer protocol. Documents will be reviewed by the appropriate leads and signed off by manager/director.
- The resource will work collaboratively with the Ontario Health team throughout the assignment and ensure key deliverables milestones and documentation are shared.
- A walkthrough of any demos development etc. will be required before the end of the engagement.
and nbsp;
Must Haves:
- 7 years of continuous experience in creating technical documentation for complex software integrations Application Programming Interface (API) specifications or system implementation guides.
- 7 years and nbsp;Demonstrated ability to capture complex technical input from architects and developers and translate it into clear structured and user-friendly documentation for a technical audience.
- 7Proficiency and nbsp;with and nbsp;diagramming and nbsp;tools and nbsp;for and nbsp;creating and nbsp;workflow and nbsp;visuals and nbsp;(e.g. and nbsp; and nbsp;Lucid and nbsp;chart and nbsp;Visio).
- 7 years and nbsp;Excellent verbal and written communication skills with proven ability to collaborate effectively with technical teams and stakeholders.
Employment Type
Full Time
Key Skills
Report This Job
Disclaimer: Drjobpro.com is only a platform that connects job seekers and employers. Applicants are advised to conduct their own independent research into the credentials of the prospective employer.We always make certain that our clients do not endorse any request for money payments, thus we advise against sharing any personal or bank-related information with any third party. If you suspect fraud or malpractice, please contact us via contact us page.
