This wiki has undergone a migration to Confluence found Here

NLM - FHIR services on VSAC

From HL7Wiki
Revision as of 14:53, 7 May 2016 by Rhausam (talk | contribs)
Jump to navigation Jump to search

Updated since the January Orlando Connectathon: Added CodeSystem service to the NLM FHIR server. It can support code lookup with the latest code system version as well as a specific CS version or date. The version parameter takes precedence when both version and date are presented. The date is in “yyyymmdd” format, for example “20160506”.

URLs and OIDs for the Connectathon:


Base URL: https://vsac-qa.nlm.nih.gov/fhir/ValueSet (Note: The base URL isn't conformant, but the specific URLs below should work.)


Preferred OIDs to use are:

5.4.3.2.1.0.1 -> for extensional-case-1

5.4.3.2.1.0.2 -> for extensional-case-2

5.4.3.2.1.0.3 -> for extensional-case-3

5.4.3.2.1.0.4 -> for extensional-case-4

5.4.3.2.1.0.5 -> for intensional-case-1

5.4.3.2.1.0.6 -> for intensional-case-2

5.4.3.2.1.0.7 -> for intensional-case-3


With operations of:

              $expand
              $expand?filter
              $validate?options  ( both GET and POST methods )
              $validate-code?options  ( both GET and POST methods )
              $lookup?options ( both GET and POST methods )      


For example:


Value Set operations:

https://vsac-qa.nlm.nih.gov/fhir/ValueSet/5.4.3.2.1.0.6

https://vsac-qa.nlm.nih.gov/fhir/ValueSet/5.4.3.2.1.0.2/$expand

https://vsac-qa.nlm.nih.gov/fhir/ValueSet/5.4.3.2.1.0.3/$expand?filter=fail

https://vsac-qa.nlm.nih.gov/fhir/ValueSet/5.4.3.2.1.0.5/$validate-code?system=http://loinc.org&code=11377-9


Code System operations:

https://vsac-qa.nlm.nih.gov/fhir/CodeSystem/$lookup?system=http://loinc.org&code=1963-8

https://vsac-qa.nlm.nih.gov/fhir/CodeSystem/$lookup?system=http://loinc.org&code=1963-8&version=2.52

https://vsac-qa.nlm.nih.gov/fhir/CodeSystem/$lookup?system=http://loinc.org&code=1963-8&date=20150501


The following code systems can be used in Fhir syntax with $lookup operation. Users would need to follow the Fhir spec. to add information to http header and/or request body for these operations. A user can use either Fhir code system format or VSAC format as following table:

Fhir Code System Name VSAC Code System Name Version Effective Date
ActMood HL7V3.0_2014-08 8/7/2014
ActPriority HL7V3.0_2014-08 8/7/2014
ActReason HL7V3.0_2014-08 8/7/2014
ActStatus HL7V3.0_2014-08 8/7/2014
AddressUse HL7V3.0_2014-08 8/7/2014
AdministrativeGender HL7V3.0_2014-08 8/7/2014
AdministrativeSex HL7V2.5 8/30/2003
CDCREC 1 3/31/2000
CDT 2016 1/1/2016
CDT 2015 1/1/2015
CDT 2014 1/1/2014
CDT 2013 1/1/2013
http://www.ama-assn.org/go/cpt CPT 2016 1/1/2016
CPT 2015 1/1/2015
CPT 2014 1/1/2014
CPT 2013 1/1/2013
CPT 2012 1/1/2012
CPT 2006 1/1/2006
CPT 1998 1/1/1998
http://hl7.org/fhir/sid/cvx CVX 2016 1/1/2016
CVX 2015 1/1/2015
CVX 2014 1/1/2014
CVX 2013 1/1/2013
CVX 2012 1/1/2012
Confidentiality HL7V3.0_2014-08 8/7/2014
DischargeDisposition HL7V2.5 8/30/2003
EntityNamePartQualifier HL7V3.0_2014-08 8/7/2014
EntityNameUse HL7V3.0_2014-08 8/7/2014
HCPCS 2016 1/1/2016
HCPCS 2015 1/1/2015
HCPCS 2014 1/1/2014
HCPCS 2013 1/1/2013
HCPCS 2012 1/1/2012
HSLOC 2010 8/12/2010
http://hl7.org/fhir/sid/icd-10 ICD10CM 2016 1/1/2016
ICD10CM 2015 1/1/2015
ICD10CM 2014 1/1/2014
ICD10CM 2013 1/1/2013
ICD10CM 2012 1/1/2012
http://www.icd10data.com/icd10pcs ICD10PCS 2016 1/1/2016
ICD10PCS 2015 1/1/2015
ICD10PCS 2014 1/1/2014
ICD10PCS 2013 1/1/2013
ICD10PCS 2012 1/1/2012
http://hl7.org/fhir/sid/icd-9-cm ICD9CM 2013 1/1/2013
ICD9CM 2012 1/1/2012
http://loinc.org LOINC 2.54 12/28/2015
LOINC 2.52 6/30/2015
LOINC 2.5 12/19/2014
LOINC 2.48 6/30/2014
LOINC 2.46 12/26/2013
LOINC 2.44 6/29/2013
LOINC 2.42 12/31/2012
LOINC 2.4 6/30/2012
LanguageAbilityMode HL7V3.0_2014-08 8/7/2014
LanguageAbilityProficiency HL7V3.0_2014-08 8/7/2014
LivingArrangement HL7V3.0_2014-08 8/7/2014
MaritalStatus HL7V3.0_2014-08 8/7/2014
NullFlavor HL7V3.0_2014-08 8/7/2014
ObservationInterpretation HL7V3.0_2014-08 8/7/2014
ParticipationFunction HL7V3.0_2014-08 8/7/2014
ParticipationMode HL7V3.0_2014-08 8/7/2014
http://hl7.org/fhir/patient-contact-relationship PatientContactRelationship 0.4 12/12/2014
http://www.nlm.nih.gov/research/umls/rxnorm RXNORM 2016-05 5/2/2016
RXNORM 2016-04 4/4/2016
RXNORM 2016-03 3/7/2016
RXNORM 2016-02 2/1/2016
RXNORM 2016-01 1/4/2016
RXNORM 2015-12 12/7/2015
RXNORM 2015-11 11/2/2015
RXNORM 2015-10 10/5/2015
RXNORM 2015-09 9/9/2015
RXNORM 2015-08 8/3/2015
RXNORM 2015-07 7/6/2015
RXNORM 2015-06 6/1/2015
RXNORM 2015-05 5/4/2015
RXNORM 2015-04 4/6/2015
RXNORM 2015-03 3/2/2015
RXNORM 2015-02 2/2/2015
RXNORM 2015-01 1/1/2015
RXNORM 2014-12 12/1/2014
RXNORM 2014-11 11/3/2014
RXNORM 2014-10 10/6/2014
RXNORM 2014-09 9/2/2014
RXNORM 2014-08 8/4/2014
RXNORM 2014-07 7/7/2014
RXNORM 2014-06 6/2/2014
RXNORM 2014-05 5/5/2014
RXNORM 2014-04 4/7/2014
RXNORM 2014-03 3/3/2014
RXNORM 2014-02 2/3/2014
RXNORM 2014-01 1/6/2014
RXNORM 2013-12 12/2/2013
RXNORM 2013-11 11/4/2013
RXNORM 2013-10 10/7/2013
RXNORM 2013-02 2/4/2013
RXNORM 2012-08 8/6/2012
ReligiousAffiliation HL7V3.0_2014-08 8/7/2014
RoleClass HL7V3.0_2014-08 8/7/2014
http://hl7.org/fhir/v3/RoleCode RoleCode HL7V3.0_2014-08 8/7/2014
RoleStatus HL7V3.0_2014-08 8/7/2014
http://snomed.info/sct SNOMEDCT 2016-03 3/1/2016
SNOMEDCT 2015-09 9/1/2015
SNOMEDCT 2015-03 3/1/2015
SNOMEDCT 2014-09 9/1/2014
SNOMEDCT 2014-03 3/1/2014
SNOMEDCT 2013-09 9/1/2013
SNOMEDCT 2013-03 3/1/2013
SNOMEDCT 2013-01 1/31/2013
SNOMEDCT 2012-09 9/1/2012
SNOMEDCT 2012-07 7/31/2012
SNOMEDCT 2012-03 3/1/2012
SOP 6 9/1/2015
SOP 5 10/1/2011
UMLS 2015AB 11/9/2015
UMLS 2015AA 5/6/2015
UMLS 2014AB 11/10/2014
UMLS 2014AA 5/31/2014

Actually, any value set and code system in VSAC QA environment can be used with the above operations. If you have a VSAC user account, you can go to VSAC QA to identify a value set and run above operations. Please notice that you can also use VSAC code system syntax with $lookup operations.