mitre/vrdr-microservice

vrdr-dotnet

镜像概述和主要用途

vrdr-dotnet是一个.NET (C#)代码仓库，主要用于处理生死记录报告（VRDR）相关的Health Level 7 (HL7) Fast Healthcare Interoperability Resources (FHIR)标准。其核心用途包括：生成和消费VRDR FHIR文档、处理VRDR文档交换的FHIR消息，以及在VRDR FHIR记录与跨辖区交换（IJE）Mortality格式之间进行转换，并提供配套的转换微服务。

核心功能和特性

• VRDR FHIR文档处理：支持生成和消费符合HL7 FHIR US VRDR实施指南的生死记录文档。
• FHIR消息处理：提供创建和解析VRDR文档交换所需的FHIR消息的类库。
• 格式转换：支持VRDR FHIR记录与IJE Mortality格式的双向转换。
• 微服务支持：提供可部署的HTTP微服务，暴露端点用于IJE与FHIR（XML/JSON）格式的转换。
• 多版本支持：兼容VRDR IG STU1、FHIR R4版本，提供NuGet包便于集成。

使用场景和适用范围

• 健康数据交换：适用于机构、公共卫生部门之间生死记录数据的标准化交换。
• 数据格式转换：需要在FHIR标准格式与IJE Mortality格式之间进行数据转换的场景。
• 应用开发集成：作为库集成到.NET应用中，实现VRDR FHIR文档的生成、解析和消息处理。
• 微服务部署：通过Docker部署转换微服务，提供HTTP接口服务。

详细使用方法和配置说明

版本信息

环境要求

开发与CLI要求

• 基于.NET Core 3.1构建，可从.NET官网下载。
• 也可使用.NET Core 2.1，具体参见VRDR.CLI部分说明。

库使用要求

• VRDR和VRDR.Messaging库目标为.NET Standard 2.0。
• 需根据.NET实现支持矩阵确认所用.NET版本是否支持.NET Standard 2.0。

项目组件使用说明

VRDR库

用途：提供FHIR生死记录库，支持VRDR FHIR的生成、消费及与IJE Mortality格式的转换。

安装：通过NuGet引用：

xml
<ItemGroup>
  ...
  <PackageReference Include="VRDR" Version="3.1.1" />
  ...
</ItemGroup>

或本地引用项目文件：

xml
<Project Sdk="Microsoft.NET.Sdk">
  ...
  <ItemGroup>
    <ProjectReference Include="..\VRDR\DeathRecord.csproj" />
    ...
  </ItemGroup>
</Project>

生成VRDR FHIR记录示例：

cs
using VRDR;

DeathRecord deathRecord = new DeathRecord();
deathRecord.Identifier = "42"; // 设置记录ID
deathRecord.GivenNames = new string[] { "First", "Middle" }; // 死者名
deathRecord.FamilyName = "Last"; // 死者姓
deathRecord.COD1A = "Rupture of myocardium"; // 死因第一部分a行
deathRecord.INTERVAL1A = "Minutes"; // 死因间隔
// 设置死因编码
Dictionary<string, string> exampleCode = new Dictionary<string, string>();
exampleCode.Add("code", "I21.0");
exampleCode.Add("system", "ICD-10");
exampleCode.Add("display", "Acute transmural myocardial infarction of anterior wall");
deathRecord.CODE1A = exampleCode;
// 设置怀孕状态
Dictionary<string, string> code = new Dictionary<string, string>();
code.Add("code", "PHC1260");
code.Add("system", "urn:oid:2.16.840.1.114222.4.5.274");
code.Add("display", "Not pregnant within past year");
deathRecord.PregnancyStatus = code;
deathRecord.ExaminerContacted = false; // 检查者是否联系
deathRecord.DateOfDeath = "2018-07-10T10:04:00+00:00"; // 死亡日期时间

Console.WriteLine(deathRecord.ToJSON()); // 输出JSON格式记录

消费VRDR FHIR记录示例：

cs
using VRDR;

// 读取FHIR XML文件
string xml = File.ReadAllText("./example_vrdr_fhir_record.xml");
// 从XML构造DeathRecord对象
DeathRecord deathRecord = new DeathRecord(xml);

// 输出记录详情
Console.WriteLine($"死者姓: {deathRecord.FamilyName}");
Console.WriteLine($"死亡日期时间: {deathRecord.DateOfDeath}");
Console.WriteLine($"死因第一部分a行: {deathRecord.COD1A}");
Console.WriteLine($"死因间隔a行: {deathRecord.INTERVAL1A}");
Console.WriteLine($"死因编码a行: {String.Join(", ", deathRecord.CODE1A.Select(x => x.Key + "=" + x.Value).ToArray())}");

FHIR与IJE格式转换示例：

• FHIR转IJE：

cs
using VRDR;

string xml = File.ReadAllText("./example_vrdr_fhir_record.xml");
DeathRecord deathRecord = new DeathRecord(xml);
IJEMortality ije = new IJEMortality(deathRecord);
string ijeString = ije.ToString(); // 转换为IJE字符串
Console.WriteLine(ijeString);

• IJE转FHIR：

cs
using VRDR;

IJEMortality ije = new IJEMortality("..."); // 从IJE字符串构造
DeathRecord deathRecord = ije.ToDeathRecord();
Console.WriteLine(deathRecord.ToJSON()); // 输出JSON格式FHIR记录

VRDR.Messaging库

用途：提供创建和解析VRDR文档交换FHIR消息的类。

安装：通过NuGet引用（自动包含VRDR库）：

xml
<ItemGroup>
  ...
  <PackageReference Include="VRDR.Messaging" Version="3.1.1" />
  ...
</ItemGroup>

或本地引用项目文件：

xml
<Project Sdk="Microsoft.NET.Sdk">
  ...
  <ItemGroup>
    <ProjectReference Include="..\VRDR.Messaging\VRDRMessaging.csproj" />
    ...
  </ItemGroup>
</Project>

消息处理示例（编码响应消息）：

cs
using VRDR;

// 创建编码响应消息
CodingResponseMessage message = new CodingResponseMessage("https://example.org/jurisdiction/endpoint");
// 设置业务标识符
message.CertificateNumber = "...";
message.StateAuxiliaryIdentifier = "...";
message.NCHSIdentifier = "...";
// 设置根本死因编码
message.UnderlyingCauseOfDeath = "<icd code>";
// 设置记录轴编码
var recordAxisCodes = new List<string> { "<icd code>", "<icd code>", "<icd code>", "<icd code>" };
message.CauseOfDeathRecordAxis = recordAxisCodes;
// 设置实体轴编码
var builder = new CauseOfDeathEntityAxisBuilder();
builder.Add(<lineNumber>, <positionInLine>, <icd code>); // 添加实体轴编码
message.CauseOfDeathEntityAxis = builder.ToCauseOfDeathEntityAxis();

string jsonMessage = message.ToJSON(); // 转换为JSON消息

VRDR.CLI工具

用途：命令行工具，支持FHIR与IJE格式转换、文档验证等操作。

使用示例（.NET Core 3.1）：

bash
# 生成示例FHIR记录并输出XML和JSON
dotnet run

# FHIR XML转IJE
dotnet run 2ije 1.xml

# IJE转FHIR XML
dotnet run ije2xml 1.MOR

# IJE转FHIR JSON
dotnet run ije2json 1.MOR

# FHIR XML转JSON
dotnet run xml2json 1.xml

# FHIR JSON转XML
dotnet run json2xml 1.json

# 验证FHIR XML
dotnet run checkXml 1.xml

注：使用.NET Core 2.1时，需在命令后添加--framework netcoreapp2.1

VRDR.HTTP微服务

用途：提供HTTP端点，支持IJE与FHIR（XML/JSON）格式的转换。

端点：

• http://<server>:8080/xml：请求FHIR XML格式记录
• http://<server>:8080/json：请求FHIR JSON格式记录
• http://<server>:8080/ije：请求IJE格式记录

请求头：需包含Content-Type，指定请求体格式（application/fhir+json、application/fhir+xml或application/ije）。

Docker部署：

bash
# 构建Docker镜像
dotnet publish
docker build -t vrdr-microservice -f ./VRDR.HTTP/Dockerfile .

# 运行容器
docker run -p 8080:8080 vrdr-microservice

本地运行（不使用Docker）：

bash
dotnet run

服务将监听http://localhost:8080。

许可证

Copyright 2018, 2019, 2020 The MITRE Corporation

基于Apache License 2.0许可。详情参见[***]

联系信息

如有问题或反馈，请发送邮件至：***