[{"_1":2,"_187":-5,"_188":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_163":164},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_94":95,"_118":119,"_156":-5,"_157":11,"_158":17,"_159":11,"_160":-5,"_161":162},"canonicalUrl","https://hub.docker.com/r/mitre/vrdr-microservice/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","mitre","reponame","vrdr-microservice","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_49":50,"_52":53,"_54":55,"_56":11,"_57":58,"_59":60,"_61":62,"_39":31,"_28":29,"_64":65,"_66":51,"_67":68,"_69":70,"_71":72,"_73":-5,"_74":68,"_75":76,"_77":11,"_78":29,"_79":80,"_85":11,"_86":87,"_91":29,"_92":93},"categories",[38,43,46],{"_39":40,"_41":42},"name","Security","slug","security",{"_39":44,"_41":45},"Integration & delivery","integration-and-delivery",{"_39":47,"_41":48},"API management","api-management","content_types",[51],"image","date_registered","2020-03-26T19:24:30.899728Z","description","","is_private","last_updated","2021-07-21T20:09:00.095099Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[63],"application/vnd.docker.container.image.v1+json","pull_count",5804,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","[![Build Status](https://travis-ci.org/nightingaleproject/vrdr-dotnet.svg?branch=master)](https://travis-ci.org/nightingaleproject/vrdr-dotnet)\n[![Nuget](https://img.shields.io/nuget/v/VRDR?label=VRDR%20%28nuget%29)](https://www.nuget.org/packages/VRDR)\n[![Nuget](https://img.shields.io/nuget/v/VRDR.Messaging?label=VRDR.Messaging%20%28nuget%29)](https://www.nuget.org/packages/VRDR.Messaging)\n\n# vrdr-dotnet\n\nThis repository includes .NET (C#) code for\n\n- Producing and consuming the Vital Records Death Reporting (VRDR) Health Level 7 (HL7) Fast Healthcare Interoperability Resources (FHIR) standard. [Click here to view the FHIR Implementation Guide](http://hl7.org/fhir/us/vrdr/).\n- Producing and consuming FHIR messages for the exchange of VRDR documents.\n- Support for converting VRDR FHIR records to and from the Inter-Jurisdictional Exchange (IJE) Mortality format, as well as companion microservice for performing conversions.\n\n## Documentation\n\n[Doxygen Docs](https://nightingaleproject.github.io/vrdr-dotnet/)\n\n## Versions\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

VRDR IG	FHIR	Version	VRDR.dotnet	VRDR.Messaging
STU1	R4	V3.1.1	nuget github	nuget github

\n\n## Requirements\n\n### Development & CLI Requirements\n- This repository is built using .NET Core 3.1, download [here](https://dotnet.microsoft.com/download)\n- You can also use .NET Core 2.1, see VRDR.CLI section below for instructions\n### Library Usage\n- The VRDR or VRDR.Messaging libraries target .NET Standard 2.0\n- To check wether your .NET version supports a release, refer to (this)[https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support] .NET matrix. First, note whether you are using .NET Core or .NET Framework - see (here)[https://docs.microsoft.com/en-us/archive/msdn-magazine/2017/september/net-standard-demystifying-net-core-and-net-standard] for distinctions between the .NET implementation option. Once you’ve determined your .NET implementation type and version, for example you are using .NET Framework 4.6.1, refer to the matrix to verify whether your .NET implementation supports the targeted .NET Standard version. By looking at the matrix, you can see the .NET Framework 4.6.1 supports .NET Standard 2.0 so the tool would be supported.\n\n## Project Organization\n\n### VRDR\nThis directory contains a FHIR Death Record library for consuming and producing VRDR FHIR. This library also includes support for converting to and from the Inter-Jurisdictional Exchange (IJE) Mortality format.\n\nFor API documentation, [click here](VRDR/DeathRecord.md).\n\n#### Usage\n\nThis package is published on NuGet, so including it is as easy as:\n```xml\n\n ...\n \n ...\n\n```\n\nYou can also include a locally downloaded copy of the library instead of the NuGet version by referencing `DeathRecord.csproj` in your project configuration, for example (taken from VRDR.CLI):\n```xml\n\n ...\n \n \n ...\n \n\n```\n\n#### Producing Example\nThe following snippet is a quick example of producing a from-scratch FHIR VRDR record using this library, and then printing it out as a JSON string. For a complete example, [click here](https://github.com/nightingaleproject/csharp-fhir-death-record/blob/master/VRDR.CLI/Program.cs#L23).\n```cs\nusing VRDR;\n\nDeathRecord deathRecord = new DeathRecord();\n\n// Set Death Record ID\ndeathRecord.Identifier = \"42\";\n\n// Add Decedent Given Names\nstring[] givenNames = { \"First\", \"Middle\" };\ndeathRecord.GivenNames = givenNames;\n\n// Add Decedent Last Name\ndeathRecord.FamilyName = \"Last\";\n\n// Cause of Death Part I, Line a\ndeathRecord.COD1A = \"Rupture of myocardium\";\n\n// Cause of Death Part I Interval, Line a\ndeathRecord.INTERVAL1A = \"Minutes\";\n\n// Cause of Death Part I Code, Line a\nDictionary exampleCode = new Dictionary();\nexampleCode.Add(\"code\", \"I21.0\");\nexampleCode.Add(\"system\", \"ICD-10\");\nexampleCode.Add(\"display\", \"Acute transmural myocardial infarction of anterior wall\");\ndeathRecord.CODE1A = exampleCode;\n\n// Add PregnancyStatus\nDictionary code = new Dictionary();\ncode.Add(\"code\", \"PHC1260\");\ncode.Add(\"system\", \"urn:oid:2.16.840.1.114222.4.5.274\");\ncode.Add(\"display\", \"Not pregnant within past year\");\ndeathRecord.PregnancyStatus = code;\n\n// Add ExaminerContacted\ndeathRecord.ExaminerContacted = false;\n\n// Add DateOfDeath\ndeathRecord.DateOfDeath = \"2018-07-10T10:04:00+00:00\";\n\n// Print record as a JSON string\nConsole.WriteLine(deathRecord.ToJSON());\n```\n\n#### Consuming Example\nAn example of consuming a VRDR FHIR document (in XML format) using this library, and printing some details from it:\n```cs\nusing VRDR;\n\n// Read in FHIR Death Record XML file as a string\nstring xml = File.ReadAllText(\"./example_vrdr_fhir_record.xml\");\n\n// Construct a new DeathRecord object from the FHIR VRDR XML string\nDeathRecord deathRecord = new DeathRecord(xml);\n\n// Print out some details from the record\nConsole.WriteLine($\"Decedent's Last Name: {deathRecord.FamilyName}\");\n\nConsole.WriteLine($\"Date/Time of Death: {deathRecord.DateOfDeath}\");\n\nConsole.WriteLine($\"Cause of Death Part I, Line a: {deathRecord.COD1A}\");\nConsole.WriteLine($\"Cause of Death Part I Interval, Line a: {deathRecord.INTERVAL1A}\");\nConsole.WriteLine($\"Cause of Death Part I Code, Line a: {String.Join(\", \", deathRecord.CODE1A.Select(x => x.Key + \"=\" + x.Value).ToArray())}\");\n```\n\n#### FHIR VRDR record to/from IJE Mortality format\nAn example of converting a VRDR FHIR Death Record to an IJE string:\n```cs\nusing VRDR;\n\n// Read in FHIR Death Record XML file as a string\nstring xml = File.ReadAllText(\"./example_vrdr_fhir_record.xml\");\n\n// Construct a new DeathRecord object from the string\nDeathRecord deathRecord = new DeathRecord(xml);\n\n// Create an IJEMortality instance from the DeathRecord\nIJEMortality ije = new IJEMortality(deathRecord);\n\n// Print out the corresponding IJE version of the DeathRecord\nstring ijeString = ije.ToString(); // Converts DeathRecord to IJE\nConsole.WriteLine(ijeString);\n```\n\nAn example of converting an IJE string to a VRDR FHIR Death Record:\n```cs\nusing VRDR;\n\n// Construct a new IJEMortality instance from an IJE string\nIJEMortality ije = new IJEMortality(\"...\"); // This will convert the IJE string to a DeathRecord\n\n// Grab the corresponding FHIR DeathRecord\nDeathRecord deathRecord = ije.ToDeathRecord();\n\n// Print out the converted FHIR DeathRecord as a JSON string\nConsole.WriteLine(deathRecord.ToJSON());\n```\n\n#### Return Coding\nAn example of producing a `CodingResponseMessage` for handling the returned message from NCHS containing coded causes. For a complete example, [click here](https://github.com/nightingaleproject/vrdr-dotnet/blob/master/doc/Messaging.md#return-coding).\n\n```cs\nusing VRDR;\n// Create an empty coding response message\nCodingResponseMessage message = new CodingResponseMessage(\"https://example.org/jurisdiction/endpoint\");\n\n// Assign the business identifiers\nmessage.CertificateNumber = \"...\";\nmessage.StateAuxiliaryIdentifier = \"...\";\nmessage.NCHSIdentifier = \"...\";\n\n// Create the cause of death coding\nmessage.UnderlyingCauseOfDeath = ;\n\n// Assign the record axis codes\nvar recordAxisCodes = new List();\nrecordAxisCodes.Add();\nrecordAxisCodes.Add();\nrecordAxisCodes.Add();\nrecordAxisCodes.Add();\nmessage.CauseOfDeathRecordAxis = recordAxisCodes;\n\n// Assign the entity axis codes\nvar builder = new CauseOfDeathEntityAxisBuilder();\n// for each entity axis codes\n...\nbuilder.Add(, , );\n...\n// end loop\nmessage.CauseOfDeathEntityAxis = builder.ToCauseOfDeathEntityAxis();\n\n// Create a JSON representation of the coding response message\nstring jsonMessage = message.ToJSON();\n```\nNote that the `CauseCodes` class from previous versions is now obsolete, use the `CodingResponseMessage` described above instead.\n\n### VRDR.Messaging\n\nThis directory contains classes to create and parse FHIR messages used for Vital Records Death Reporting.\n\n#### Usage\n\nThis package is published on NuGet, so including it is as easy as:\n```xml\n\n ...\n \n ...\n\n```\n\nNote that the VRDR.Messaging package automatically includes the VRDR package, a project file should not reference both.\n\nYou can also include a locally downloaded copy of the library instead of the NuGet version by referencing `VRDRMessaging.csproj` in your project configuration, for example:\n\n```xml\n\n ...\n \n \n ...\n \n\n```\n\nUse of the VRDR.Messaging library to support various message exchange scenarios is described in [`doc/Messaging.md`](doc/Messaging.md).\n\n### VRDR.Tests\nThis directory contains unit and functional tests for the VRDR library.\n\n#### Usage\nThe tests are automatically run by this repositories Travis CI config, but can be run locally by executing the following command in the root project directory:\n```bash\ndotnet test\n```\n\n### VRDR.CLI\nThis directory contains a sample command line interface app that uses the VRDR library to do a few different things.\n\nNOTE: If you would like to run the CLI using .NET core 2.1, append `--framework netcoreapp2.1` to the end of all the example commands below\n\n#### Example Usages\n```bash\n# Builds a fake death record and print out the record as FHIR XML and JSON\ndotnet run\n\n# Read in the FHIR XML or JSON death record and print out as IJE\ndotnet run 2ije 1.xml\n\n# Read in the IJE death record and print out as FHIR XML\ndotnet run ije2xml 1.MOR\n\n# Read in the IJE death record and print out as FHIR JSON\ndotnet run ije2json 1.MOR\n\n# Read in the FHIR XML death record and print out as FHIR JSON\ndotnet run xml2json 1.xml\n\n# Read in the FHIR JSON death record and print out as FHIR XML\ndotnet run json2xml 1.json\n\n# Read in the FHIR JSON death record, completely disassemble then reassemble, and print as FHIR JSON\ndotnet run json2json 1.json\n\n# Read in the FHIR XML death record, completely disassemble then reassemble, and print as FHIR XML\ndotnet run xml2xml 1.xml\n\n# Read in the given FHIR xml (being permissive) and print out the same; useful for doing validation diffs\ndotnet run checkXml 1.xml\n\n# Read in the given FHIR json (being permissive) and print out the same; useful for doing validation diffs\ndotnet run checkJson 1.json\n\n# Read in and parse an IJE death record and print out the values for every (supported) field\ndotnet run ije 1.MOR\n```\n\n### VRDR.HTTP\nThis directory contains a deployable microservice that exposes endpoints for conversion of IJE flat files to DeathRecord JSON or XML, and vice versa.\n\nThe current available endpoints to `POST` to are:\n```\nhttp://:8080/xml <- For requesting a record as FHIR in XML format\nhttp://:8080/json <- For requesting a record as FHIR in JSON format\nhttp://:8080/ije <- For requesting a record as IJE\n```\n\nInclude a `Content-Type` header indicating what format the record is represented as in the body of the message (e.g. `application/fhir+json`, `application/fhir+xml`, or `application/ije`.).\n\n#### Running\n\nTo build a Dockerized version from scratch (from source), you can do so by running (inside the project root directory):\n\n```\ndotnet publish\ndocker build -t vrdr-microservice -f ./VRDR.HTTP/Dockerfile .\ndocker run -p 8080:8080 vrdr-microservice\n```\n\nIf you prefer not to use Docker, you can run it from the root project directory using [.NET Core](https://dotnet.microsoft.com/download):\n\n```\ndotnet run\n```\n\nThe service will be listening locally at `http://localhost:8080`.\n\n#### Publishing a Version\n\nTo create a new release of VRDR on NuGet, bump the version of the VRDR and VRDR.Messaging listed in the [Directory.Build.props](Directory.Build.props) file. Whenever a commit is merged into the master branch that changes the Directory.Build.props file, [Github Actions](.github/workflows/publish.yml) will automatically build and publish a new version of the package based on the value specified.\n\n## License\n\nCopyright 2018, 2019, 2020 The MITRE Corporation\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\n```\nhttp://www.apache.org/licenses/LICENSE-2.0\n```\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n\n### Contact Information\n\nFor questions or comments about vrdr-dotnet, please send email to\n\n cdc-nvss-feedback-list@lists.mitre.org\n","has_starred","hub_user","immutable_tags_settings",{"_81":11,"_82":83},"enabled","rules",[84],".*","is_automated","permissions",{"_88":17,"_89":11,"_90":11},"read","write","admin","user","storage_size",2398953445,"orgData",{"_96":97,"_98":99,"_100":101,"_102":29,"_103":104,"_105":106,"_107":104,"_108":109,"_110":111,"_112":113,"_114":55,"_115":116,"_117":17},"id","c33f04871454490f9a29b89b5b127d97","uuid","c33f0487-1454-490f-9a29-b89b5b127d97","type","organization","orgname","full_name","The MITRE Corporation","location","McLean, VA","company","profile_url","https://www.mitre.org","date_joined","2017-12-13T13:26:39.124579Z","gravatar_url","https://www.gravatar.com/avatar/edc9b8d540a762965b8c6770016d0e57?s=80&r=g&d=mm","gravatar_email","badge","open_source","is_active","recentTags",[120],{"_121":51,"_122":123,"_124":125,"_96":126,"_127":128,"_57":145,"_146":123,"_147":29,"_148":63,"_39":149,"_150":151,"_152":136,"_153":145,"_154":72,"_155":17},"content_type","creator",2479580,"full_size",110802220,92695574,"images",[129],{"_130":131,"_132":133,"_134":55,"_135":136,"_137":138,"_139":140,"_141":55,"_142":-5,"_143":125,"_69":72,"_144":-5},"architecture","amd64","digest","sha256:c30a00b2ba7f7767dbd557a104f461a72fe3eb5be254ff1e5954880d5f2bae9b","features","last_pulled","2026-09-17T21:11:05.117871328Z","last_pushed","2021-07-21T20:09:00Z","os","linux","os_features","os_version","size","variant","2021-07-21T20:08:59.80124Z","last_updater","last_updater_username","media_type","latest","repository",8717476,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":165,"_175":176,"_161":185,"_186":11},{"_36":166,"_49":170,"_52":53,"_54":55,"_56":11,"_57":58,"_59":60,"_61":171,"_39":31,"_28":29,"_64":65,"_66":51,"_67":68,"_69":70,"_71":72,"_73":-5,"_74":68,"_75":76,"_77":11,"_78":29,"_79":172,"_85":11,"_86":174,"_91":29,"_92":93},[167,168,169],{"_39":40,"_41":42},{"_39":44,"_41":45},{"_39":47,"_41":48},[51],[63],{"_81":11,"_82":173},[84],{"_88":17,"_89":11,"_90":11},"tags",{"_177":70,"_178":-5,"_179":-5,"_180":181},"count","next","previous","results",[182],{"_121":51,"_122":123,"_124":125,"_96":126,"_127":183,"_57":145,"_146":123,"_147":29,"_148":63,"_39":149,"_150":151,"_152":136,"_153":145,"_154":72,"_155":17},[184],{"_130":131,"_132":133,"_134":55,"_135":136,"_137":138,"_139":140,"_141":55,"_142":-5,"_143":125,"_69":72,"_144":-5},[],"canDeleteTags","actionData","errors"]

mitre/vrdr-microservice

Tags for mitre/vrdr-microservice