From 8d462f3cda618f3d7851da24dd6c00510d38374b Mon Sep 17 00:00:00 2001 From: jamesagnew Date: Sat, 23 Aug 2014 16:40:26 -0400 Subject: [PATCH] Add validator support --- .../main/java/example/ValidatorExamples.java | 44 + hapi-fhir-base/pom.xml | 19 +- .../java/ca/uhn/fhir/context/FhirContext.java | 86 +- .../context/RuntimeResourceDefinition.java | 183 +- .../ca/uhn/fhir/validation/IValidator.java | 8 + .../ca/uhn/fhir/validation/LSInputImpl.java | 99 + .../java/ca/uhn/fhir/validation/Problem.java | 15 + .../fhir/validation/ResourceValidator.java | 113 + .../fhir/validation/SchemaBaseValidator.java | 147 + .../validation/SchematronBaseValidator.java | 77 + .../fhir/validation/ValidationContext.java | 41 + .../ValidationFailureException.java | 34 + .../model/dstu/resource/adversereaction.sch | 33 + .../ca/uhn/fhir/model/dstu/resource/alert.sch | 30 + .../dstu/resource/allergyintolerance.sch | 30 + .../uhn/fhir/model/dstu/resource/careplan.sch | 90 + .../fhir/model/dstu/resource/composition.sch | 87 + .../fhir/model/dstu/resource/conceptmap.sch | 25 + .../fhir/model/dstu/resource/condition.sch | 123 + .../fhir/model/dstu/resource/conformance.sch | 74 + .../uhn/fhir/model/dstu/resource/device.sch | 39 + .../dstu/resource/deviceobservationreport.sch | 42 + .../model/dstu/resource/diagnosticorder.sch | 60 + .../model/dstu/resource/diagnosticreport.sch | 66 + .../model/dstu/resource/documentmanifest.sch | 54 + .../model/dstu/resource/documentreference.sch | 105 + .../fhir/model/dstu/resource/encounter.sch | 147 + .../model/dstu/resource/familyhistory.sch | 74 + .../uhn/fhir/model/dstu/resource/fhir-all.xsd | 82 + .../fhir/model/dstu/resource/fhir-single.xsd | 12358 ++++++++++++++++ .../ca/uhn/fhir/model/dstu/resource/group.sch | 65 + .../fhir/model/dstu/resource/imagingstudy.sch | 48 + .../fhir/model/dstu/resource/immunization.sch | 111 + .../resource/immunizationrecommendation.sch | 54 + .../ca/uhn/fhir/model/dstu/resource/list.sch | 55 + .../uhn/fhir/model/dstu/resource/location.sch | 48 + .../ca/uhn/fhir/model/dstu/resource/media.sch | 45 + .../fhir/model/dstu/resource/medication.sch | 57 + .../resource/medicationadministration.sch | 111 + .../dstu/resource/medicationdispense.sch | 157 + .../dstu/resource/medicationprescription.sch | 151 + .../dstu/resource/medicationstatement.sch | 109 + .../model/dstu/resource/messageheader.sch | 51 + .../fhir/model/dstu/resource/observation.sch | 124 + .../fhir/model/dstu/resource/opensearch.xsd | 11 + .../model/dstu/resource/opensearchscore.xsd | 22 + .../model/dstu/resource/operationoutcome.sch | 15 + .../ca/uhn/fhir/model/dstu/resource/order.sch | 67 + .../model/dstu/resource/orderresponse.sch | 36 + .../fhir/model/dstu/resource/organization.sch | 78 + .../ca/uhn/fhir/model/dstu/resource/other.sch | 30 + .../uhn/fhir/model/dstu/resource/patient.sch | 126 + .../fhir/model/dstu/resource/practitioner.sch | 87 + .../fhir/model/dstu/resource/procedure.sch | 78 + .../uhn/fhir/model/dstu/resource/profile.sch | 71 + .../fhir/model/dstu/resource/provenance.sch | 45 + .../ca/uhn/fhir/model/dstu/resource/query.sch | 12 + .../model/dstu/resource/questionnaire.sch | 73 + .../model/dstu/resource/relatedperson.sch | 48 + .../model/dstu/resource/securityevent.sch | 76 + .../uhn/fhir/model/dstu/resource/specimen.sch | 99 + .../fhir/model/dstu/resource/substance.sch | 39 + .../uhn/fhir/model/dstu/resource/supply.sch | 66 + .../fhir/model/dstu/resource/tombstone.xsd | 17 + .../uhn/fhir/model/dstu/resource/valueset.sch | 36 + .../model/dstu/resource/xhtml1-strict.xsd | 2044 +++ .../ca/uhn/fhir/model/dstu/resource/xml.xsd | 272 + .../dstu/resource/xmldsig-core-schema.xsd | 254 + hapi-fhir-base/src/site/site.xml | 1 + .../src/site/xdoc/doc_validation.xml | 67 + .../ca/uhn/fhir/context/ModelScannerTest.java | 5 +- .../validation/ResourceValidatorTest.java | 71 + .../org.eclipse.wst.common.component | 2 +- pom.xml | 1 + .../org.eclipse.wst.common.component | 2 +- 75 files changed, 19306 insertions(+), 116 deletions(-) create mode 100644 hapi-fhir-base/examples/src/main/java/example/ValidatorExamples.java create mode 100644 hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/IValidator.java create mode 100644 hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/LSInputImpl.java create mode 100644 hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/Problem.java create mode 100644 hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ResourceValidator.java create mode 100644 hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/SchemaBaseValidator.java create mode 100644 hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/SchematronBaseValidator.java create mode 100644 hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ValidationContext.java create mode 100644 hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ValidationFailureException.java create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/adversereaction.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/alert.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/allergyintolerance.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/careplan.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/composition.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/conceptmap.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/condition.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/conformance.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/device.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/deviceobservationreport.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/diagnosticorder.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/diagnosticreport.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/documentmanifest.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/documentreference.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/encounter.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/familyhistory.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/fhir-all.xsd create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/fhir-single.xsd create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/group.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/imagingstudy.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/immunization.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/immunizationrecommendation.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/list.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/location.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/media.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medication.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationadministration.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationdispense.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationprescription.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationstatement.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/messageheader.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/observation.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/opensearch.xsd create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/opensearchscore.xsd create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/operationoutcome.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/order.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/orderresponse.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/organization.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/other.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/patient.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/practitioner.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/procedure.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/profile.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/provenance.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/query.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/questionnaire.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/relatedperson.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/securityevent.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/specimen.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/substance.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/supply.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/tombstone.xsd create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/valueset.sch create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xhtml1-strict.xsd create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xml.xsd create mode 100644 hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xmldsig-core-schema.xsd create mode 100644 hapi-fhir-base/src/site/xdoc/doc_validation.xml create mode 100644 hapi-fhir-base/src/test/java/ca/uhn/fhir/validation/ResourceValidatorTest.java diff --git a/hapi-fhir-base/examples/src/main/java/example/ValidatorExamples.java b/hapi-fhir-base/examples/src/main/java/example/ValidatorExamples.java new file mode 100644 index 00000000000..47f5830d210 --- /dev/null +++ b/hapi-fhir-base/examples/src/main/java/example/ValidatorExamples.java @@ -0,0 +1,44 @@ +package example; + +import java.io.IOException; + +import ca.uhn.fhir.context.FhirContext; +import ca.uhn.fhir.model.dstu.resource.Patient; +import ca.uhn.fhir.model.dstu.valueset.ContactSystemEnum; +import ca.uhn.fhir.parser.DataFormatException; +import ca.uhn.fhir.validation.ResourceValidator; +import ca.uhn.fhir.validation.ValidationFailureException; + +public class ValidatorExamples { + + public static void main(String[] args) throws DataFormatException, IOException { + + //START SNIPPET: basicValidation + // As always, you need a context + FhirContext ctx = new FhirContext(); + + // Create and populate a new patient object + Patient p = new Patient(); + p.addName().addFamily("Smith").addGiven("John").addGiven("Q"); + p.addIdentifier("urn:foo:identifiers", "12345"); + p.addTelecom().setSystem(ContactSystemEnum.PHONE).setValue("416 123-4567"); + + // Request a validator and apply it + ResourceValidator val = ctx.newValidator(); + try { + + val.validate(p); + System.out.println("Validation passed"); + + } catch (ValidationFailureException e) { + // We failed validation! + + System.out.println("Validation failed"); + + String results = ctx.newXmlParser().setPrettyPrint(true).encodeResourceToString(e.getOperationOutcome()); + System.out.println(results); + } + //END SNIPPET: basicValidation + } + +} diff --git a/hapi-fhir-base/pom.xml b/hapi-fhir-base/pom.xml index 77a7335ae92..67c9288ec62 100644 --- a/hapi-fhir-base/pom.xml +++ b/hapi-fhir-base/pom.xml @@ -84,7 +84,24 @@ --> - + + + + com.phloc + phloc-schematron + ${phloc_schematron_version} + true + + + + org.apache.commons diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/context/FhirContext.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/context/FhirContext.java index cca0027cc81..f36a47f3d02 100644 --- a/hapi-fhir-base/src/main/java/ca/uhn/fhir/context/FhirContext.java +++ b/hapi-fhir-base/src/main/java/ca/uhn/fhir/context/FhirContext.java @@ -44,18 +44,23 @@ import ca.uhn.fhir.rest.client.RestfulClientFactory; import ca.uhn.fhir.rest.client.api.IBasicClient; import ca.uhn.fhir.rest.client.api.IRestfulClient; import ca.uhn.fhir.util.FhirTerser; +import ca.uhn.fhir.validation.ResourceValidator; /** - * The FHIR context is the central starting point for the use of the HAPI FHIR API. It should be created once, and then used as a factory for various other types of objects (parsers, clients, etc.). + * The FHIR context is the central starting point for the use of the HAPI FHIR API. It should be created once, and then + * used as a factory for various other types of objects (parsers, clients, etc.). * *

* Important usage notes: *

*

*/ @@ -67,7 +72,7 @@ public class FhirContext { private volatile INarrativeGenerator myNarrativeGenerator; private volatile IRestfulClientFactory myRestfulClientFactory; private volatile RuntimeChildUndeclaredExtensionDefinition myRuntimeChildUndeclaredExtensionDefinition; - + /** * Default constructor. In most cases this is the right constructor to use. */ @@ -78,7 +83,7 @@ public class FhirContext { public FhirContext(Class theResourceType) { this(toCollection(theResourceType)); } - + public FhirContext(Class... theResourceTypes) { this(toCollection(theResourceTypes)); } @@ -88,7 +93,8 @@ public class FhirContext { } /** - * Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed for extending the core library. + * Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed + * for extending the core library. */ public BaseRuntimeElementDefinition getElementDefinition(Class theElementType) { return myClassToElementDefinition.get(theElementType); @@ -99,7 +105,8 @@ public class FhirContext { } /** - * Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed for extending the core library. + * Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed + * for extending the core library. */ public RuntimeResourceDefinition getResourceDefinition(Class theResourceType) { RuntimeResourceDefinition retVal = (RuntimeResourceDefinition) myClassToElementDefinition.get(theResourceType); @@ -108,30 +115,31 @@ public class FhirContext { } return retVal; } - + /** - * Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed for extending the core library. + * Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed + * for extending the core library. */ public RuntimeResourceDefinition getResourceDefinition(IResource theResource) { return getResourceDefinition(theResource.getClass()); } /** - * Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed for extending the core library. + * Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed + * for extending the core library. */ @SuppressWarnings("unchecked") public RuntimeResourceDefinition getResourceDefinition(String theResourceName) { String resourceName = theResourceName; - + /* - * TODO: this is a bit of a hack, really we should have a translation table - * based on a property file or something so that we can detect names like - * diagnosticreport + * TODO: this is a bit of a hack, really we should have a translation table based on a property file or + * something so that we can detect names like diagnosticreport */ if (Character.isLowerCase(resourceName.charAt(0))) { resourceName = WordUtils.capitalize(resourceName); } - + Validate.notBlank(resourceName, "Resource name must not be blank"); RuntimeResourceDefinition retVal = myNameToElementDefinition.get(resourceName); @@ -152,14 +160,16 @@ public class FhirContext { } /** - * Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed for extending the core library. + * Returns the scanned runtime model for the given type. This is an advanced feature which is generally only needed + * for extending the core library. */ public RuntimeResourceDefinition getResourceDefinitionById(String theId) { return myIdToResourceDefinition.get(theId); } /** - * Returns the scanned runtime models. This is an advanced feature which is generally only needed for extending the core library. + * Returns the scanned runtime models. This is an advanced feature which is generally only needed for extending the + * core library. */ public Collection getResourceDefinitions() { return myIdToResourceDefinition.values(); @@ -180,7 +190,8 @@ public class FhirContext { * Create and return a new JSON parser. * *

- * Performance Note: This method is cheap to call, and may be called once for every message being processed without incurring any performance penalty + * Performance Note: This method is cheap to call, and may be called once for every message being processed + * without incurring any performance penalty *

*/ public IParser newJsonParser() { @@ -188,12 +199,16 @@ public class FhirContext { } /** - * Instantiates a new client instance. This method requires an interface which is defined specifically for your use cases to contain methods for each of the RESTful operations you wish to - * implement (e.g. "read ImagingStudy", "search Patient by identifier", etc.). This interface must extend {@link IRestfulClient} (or commonly its sub-interface {@link IBasicClient}). See the RESTful Client documentation for more information on how to define this interface. + * Instantiates a new client instance. This method requires an interface which is defined specifically for your use + * cases to contain methods for each of the RESTful operations you wish to implement (e.g. "read ImagingStudy", + * "search Patient by identifier", etc.). This interface must extend {@link IRestfulClient} (or commonly its + * sub-interface {@link IBasicClient}). See the RESTful Client documentation for more + * information on how to define this interface. * *

- * Performance Note: This method is cheap to call, and may be called once for every operation invocation without incurring any performance penalty + * Performance Note: This method is cheap to call, and may be called once for every operation invocation + * without incurring any performance penalty *

* * @param theClientType @@ -209,16 +224,18 @@ public class FhirContext { } /** - * Instantiates a new generic client. A generic client is able to perform any of the FHIR RESTful operations against a compliant server, but does not have methods defining the specific - * functionality required (as is the case with {@link #newRestfulClient(Class, String) non-generic clients}). + * Instantiates a new generic client. A generic client is able to perform any of the FHIR RESTful operations against + * a compliant server, but does not have methods defining the specific functionality required (as is the case with + * {@link #newRestfulClient(Class, String) non-generic clients}). * *

- * Performance Note: This method is cheap to call, and may be called once for every operation invocation without incurring any performance penalty + * Performance Note: This method is cheap to call, and may be called once for every operation invocation + * without incurring any performance penalty *

* * @param theServerBase * The URL of the base for the restful FHIR server to connect to - * @return + * @return */ public IGenericClient newRestfulGenericClient(String theServerBase) { return getRestfulClientFactory().newGenericClient(theServerBase); @@ -228,11 +245,20 @@ public class FhirContext { return new FhirTerser(this); } + public ResourceValidator newValidator() { + return new ResourceValidator(this); + } + + public ViewGenerator newViewGenerator() { + return new ViewGenerator(this); + } + /** * Create and return a new XML parser. * *

- * Performance Note: This method is cheap to call, and may be called once for every message being processed without incurring any performance penalty + * Performance Note: This method is cheap to call, and may be called once for every message being processed + * without incurring any performance penalty *

*/ public IParser newXmlParser() { @@ -298,8 +324,4 @@ public class FhirContext { return retVal; } - public ViewGenerator newViewGenerator() { - return new ViewGenerator(this); - } - } diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/context/RuntimeResourceDefinition.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/context/RuntimeResourceDefinition.java index 74ff3894696..9e4db368fa0 100644 --- a/hapi-fhir-base/src/main/java/ca/uhn/fhir/context/RuntimeResourceDefinition.java +++ b/hapi-fhir-base/src/main/java/ca/uhn/fhir/context/RuntimeResourceDefinition.java @@ -53,12 +53,13 @@ import ca.uhn.fhir.model.primitive.IdDt; public class RuntimeResourceDefinition extends BaseRuntimeElementCompositeDefinition { private static final org.slf4j.Logger ourLog = org.slf4j.LoggerFactory.getLogger(RuntimeResourceDefinition.class); + private RuntimeResourceDefinition myBaseDefinition; private Map myExtensionDefToCode = new HashMap(); + private String myId; private Map myNameToSearchParam = new LinkedHashMap(); private Profile myProfileDef; private String myResourceProfile; private List mySearchParams; - private String myId; public RuntimeResourceDefinition(String theResourceName, Class theClass, ResourceDef theResourceAnnotation) { super(theResourceName, theClass); @@ -70,6 +71,107 @@ public class RuntimeResourceDefinition extends BaseRuntimeElementCompositeDefini myNameToSearchParam.put(theParam.getName(), theParam); } + /** + * If this definition refers to a class which extends another resource definition type, this + * method will return the definition of the topmost resource. For example, if this definition + * refers to MyPatient2, which extends MyPatient, which in turn extends Patient, this method + * will return the resource definition for Patient. + *

+ * If the definition has no parent, returns this + *

+ */ + public RuntimeResourceDefinition getBaseDefinition() { + return myBaseDefinition; + } + + @Override + public ca.uhn.fhir.context.BaseRuntimeElementDefinition.ChildTypeEnum getChildType() { + return ChildTypeEnum.RESOURCE; + } + + public String getResourceProfile() { + return myResourceProfile; + } + + public RuntimeSearchParam getSearchParam(String theName) { + return myNameToSearchParam.get(theName); + } + + public List getSearchParams() { + return mySearchParams; + } + + public boolean isStandardProfile() { + return myResourceProfile.startsWith("http://hl7.org/fhir/profiles"); + } + + @Override + public void sealAndInitialize(Map, BaseRuntimeElementDefinition> theClassToElementDefinitions) { + super.sealAndInitialize(theClassToElementDefinitions); + + myNameToSearchParam = Collections.unmodifiableMap(myNameToSearchParam); + + ArrayList searchParams = new ArrayList(myNameToSearchParam.values()); + Collections.sort(searchParams, new Comparator() { + @Override + public int compare(RuntimeSearchParam theArg0, RuntimeSearchParam theArg1) { + return theArg0.getName().compareTo(theArg1.getName()); + } + }); + mySearchParams = Collections.unmodifiableList(searchParams); + + Class target = getImplementingClass(); + myBaseDefinition = this; + do { + target = target.getSuperclass(); + if (IResource.class.isAssignableFrom(target) && target.getAnnotation(ResourceDef.class)!=null) { + myBaseDefinition = (RuntimeResourceDefinition) theClassToElementDefinitions.get(target); + } + } while (target.equals(Object.class)==false); + } + + public synchronized Profile toProfile() { + if (myProfileDef != null) { + return myProfileDef; + } + + Profile retVal = new Profile(); + + RuntimeResourceDefinition def = this; + + if (StringUtils.isBlank(myId)) { + myId = getName().toLowerCase(); + } + + retVal.setId(new IdDt(myId)); + + // Scan for extensions + scanForExtensions(retVal, def); + Collections.sort(retVal.getExtensionDefn(), new Comparator() { + @Override + public int compare(ExtensionDefn theO1, ExtensionDefn theO2) { + return theO1.getCode().compareTo(theO2.getCode()); + } + }); + + // Scan for children + retVal.setName(getName()); + Structure struct = retVal.addStructure(); + LinkedList path = new LinkedList(); + + StructureElement element = struct.addElement(); + element.getDefinition().setMin(1); + element.getDefinition().setMax("1"); + + fillProfile(struct, element, def, path, null); + + retVal.getStructure().get(0).getElement().get(0).getDefinition().addType().getCode().setValue("Resource"); + + myProfileDef = retVal; + + return retVal; + } + private void fillBasics(StructureElement theElement, BaseRuntimeElementDefinition def, LinkedList path, BaseRuntimeDeclaredChildDefinition theChild) { if (path.isEmpty()) { path.add(def.getName()); @@ -234,23 +336,6 @@ public class RuntimeResourceDefinition extends BaseRuntimeElementCompositeDefini path.pollLast(); } - @Override - public ca.uhn.fhir.context.BaseRuntimeElementDefinition.ChildTypeEnum getChildType() { - return ChildTypeEnum.RESOURCE; - } - - public String getResourceProfile() { - return myResourceProfile; - } - - public RuntimeSearchParam getSearchParam(String theName) { - return myNameToSearchParam.get(theName); - } - - public List getSearchParams() { - return mySearchParams; - } - private void scanForExtensions(Profile theProfile, BaseRuntimeElementDefinition def) { BaseRuntimeElementCompositeDefinition cdef = ((BaseRuntimeElementCompositeDefinition) def); @@ -294,66 +379,4 @@ public class RuntimeResourceDefinition extends BaseRuntimeElementCompositeDefini } } - @Override - public void sealAndInitialize(Map, BaseRuntimeElementDefinition> theClassToElementDefinitions) { - super.sealAndInitialize(theClassToElementDefinitions); - - myNameToSearchParam = Collections.unmodifiableMap(myNameToSearchParam); - - ArrayList searchParams = new ArrayList(myNameToSearchParam.values()); - Collections.sort(searchParams, new Comparator() { - @Override - public int compare(RuntimeSearchParam theArg0, RuntimeSearchParam theArg1) { - return theArg0.getName().compareTo(theArg1.getName()); - } - }); - mySearchParams = Collections.unmodifiableList(searchParams); - } - - public synchronized Profile toProfile() { - if (myProfileDef != null) { - return myProfileDef; - } - - Profile retVal = new Profile(); - - RuntimeResourceDefinition def = this; - - if (StringUtils.isBlank(myId)) { - myId = getName().toLowerCase(); - } - - retVal.setId(new IdDt(myId)); - - // Scan for extensions - scanForExtensions(retVal, def); - Collections.sort(retVal.getExtensionDefn(), new Comparator() { - @Override - public int compare(ExtensionDefn theO1, ExtensionDefn theO2) { - return theO1.getCode().compareTo(theO2.getCode()); - } - }); - - // Scan for children - retVal.setName(getName()); - Structure struct = retVal.addStructure(); - LinkedList path = new LinkedList(); - - StructureElement element = struct.addElement(); - element.getDefinition().setMin(1); - element.getDefinition().setMax("1"); - - fillProfile(struct, element, def, path, null); - - retVal.getStructure().get(0).getElement().get(0).getDefinition().addType().getCode().setValue("Resource"); - - myProfileDef = retVal; - - return retVal; - } - - public boolean isStandardProfile() { - return myResourceProfile.startsWith("http://hl7.org/fhir/profiles"); - } - } diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/IValidator.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/IValidator.java new file mode 100644 index 00000000000..12e231e85d0 --- /dev/null +++ b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/IValidator.java @@ -0,0 +1,8 @@ +package ca.uhn.fhir.validation; + + +interface IValidator { + + void validate(ValidationContext theCtx); + +} diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/LSInputImpl.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/LSInputImpl.java new file mode 100644 index 00000000000..f75bbe54f51 --- /dev/null +++ b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/LSInputImpl.java @@ -0,0 +1,99 @@ +package ca.uhn.fhir.validation; + +import java.io.InputStream; +import java.io.Reader; + +import org.w3c.dom.ls.LSInput; + +class LSInputImpl implements LSInput { + + private Reader myCharacterStream; + private InputStream myByteStream; + private String myStringData; + private String mySystemId; + private String myPublicId; + private String myBaseURI; + private String myEncoding; + private boolean myCertifiedText; + + @Override + public Reader getCharacterStream() { + return myCharacterStream; + } + + @Override + public void setCharacterStream(Reader theCharacterStream) { + myCharacterStream=theCharacterStream; + } + + @Override + public InputStream getByteStream() { + return myByteStream; + } + + @Override + public void setByteStream(InputStream theByteStream) { + myByteStream=theByteStream; + } + + @Override + public String getStringData() { + return myStringData; + } + + @Override + public void setStringData(String theStringData) { + myStringData=theStringData; + } + + @Override + public String getSystemId() { + return mySystemId; + } + + @Override + public void setSystemId(String theSystemId) { + mySystemId=theSystemId; + } + + @Override + public String getPublicId() { + return myPublicId; + } + + @Override + public void setPublicId(String thePublicId) { + myPublicId=thePublicId; + } + + @Override + public String getBaseURI() { + return myBaseURI; + } + + @Override + public void setBaseURI(String theBaseURI) { + myBaseURI=theBaseURI; + } + + @Override + public String getEncoding() { + return myEncoding; + } + + @Override + public void setEncoding(String theEncoding) { + myEncoding=theEncoding; + } + + @Override + public boolean getCertifiedText() { + return myCertifiedText; + } + + @Override + public void setCertifiedText(boolean theCertifiedText) { + myCertifiedText=theCertifiedText; + } + +} diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/Problem.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/Problem.java new file mode 100644 index 00000000000..f5807cd858e --- /dev/null +++ b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/Problem.java @@ -0,0 +1,15 @@ +package ca.uhn.fhir.validation; + +public class Problem { + + private String myDescription; + + public Problem(String theDescription) { + myDescription=theDescription; + } + + public String getDescription() { + return myDescription; + } + +} diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ResourceValidator.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ResourceValidator.java new file mode 100644 index 00000000000..bc960d5b957 --- /dev/null +++ b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ResourceValidator.java @@ -0,0 +1,113 @@ +package ca.uhn.fhir.validation; + +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +import org.apache.commons.lang.Validate; + +import ca.uhn.fhir.context.FhirContext; +import ca.uhn.fhir.model.api.IResource; +import ca.uhn.fhir.model.dstu.resource.OperationOutcome; + +/** + * Resource validator, which checks resources for compliance against various + * validation schemes (schemas, schematrons, etc.) + * + *

+ * To obtain a resource validator, call {@link FhirContext#newValidator()} + *

+ */ +public class ResourceValidator { + + private static final org.slf4j.Logger ourLog = org.slf4j.LoggerFactory.getLogger(ResourceValidator.class); + + private FhirContext myContext; + private List myValidators = new ArrayList(); + + /** + * Constructor (this should not be called directly, but rather {@link FhirContext#newValidator()} should be called + * to obtain an instance of {@link ResourceValidator}) + */ + public ResourceValidator(FhirContext theFhirContext) { + myContext = theFhirContext; + setValidateBaseSchema(true); + setValidateBaseSchematron(true); + } + + /** + * Should the validator validate the resource against the base schema (the schema provided with the FHIR + * distribution itself) + */ + public boolean isValidateBaseSchema() { + return haveValidatorOfType(SchemaBaseValidator.class); + } + + /** + * Should the validator validate the resource against the base schema (the schema provided with the FHIR + * distribution itself) + */ + public void setValidateBaseSchema(boolean theValidateBaseSchema) { + addOrRemoveValidator(theValidateBaseSchema, SchemaBaseValidator.class, new SchemaBaseValidator()); + } + + /** + * Should the validator validate the resource against the base schema (the schema provided with the FHIR + * distribution itself) + */ + public boolean isValidateBaseSchematron() { + return haveValidatorOfType(SchematronBaseValidator.class); + } + + /** + * Should the validator validate the resource against the base schematron (the schematron provided with the FHIR + * distribution itself) + */ + public void setValidateBaseSchematron(boolean theValidateBaseSchematron) { + addOrRemoveValidator(theValidateBaseSchematron, SchematronBaseValidator.class, new SchematronBaseValidator()); + } + + + public void validate(IResource theResource) throws ValidationFailureException { + Validate.notNull(theResource, "theResource must not be null"); + + ValidationContext ctx = new ValidationContext(myContext, theResource); + + for (IValidator next : myValidators) { + next.validate(ctx); + } + + OperationOutcome oo = ctx.getOperationOutcome(); + if (oo != null && oo.getIssue().size() > 0) { + throw new ValidationFailureException(oo.getIssueFirstRep().getDetails().getValue(), oo); + } + + } + + private void addOrRemoveValidator(boolean theValidateBaseSchema, Class type, IValidator instance) { + if (theValidateBaseSchema) { + boolean found = haveValidatorOfType(type); + if (!found) { + myValidators.add(instance); + } + } else { + for (Iterator iter = myValidators.iterator(); iter.hasNext();) { + IValidator next = iter.next(); + if (next.getClass().equals(type)) { + iter.remove(); + } + } + } + } + + private boolean haveValidatorOfType(Class type) { + boolean found = false; + for (IValidator next : myValidators) { + if (next.getClass().equals(type)) { + found = true; + } + } + return found; + } + +} diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/SchemaBaseValidator.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/SchemaBaseValidator.java new file mode 100644 index 00000000000..c6102198497 --- /dev/null +++ b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/SchemaBaseValidator.java @@ -0,0 +1,147 @@ +package ca.uhn.fhir.validation; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.StringReader; +import java.io.UnsupportedEncodingException; + +import javax.xml.XMLConstants; +import javax.xml.transform.Source; +import javax.xml.transform.stream.StreamSource; +import javax.xml.validation.Schema; +import javax.xml.validation.SchemaFactory; +import javax.xml.validation.Validator; + +import org.apache.commons.io.IOUtils; +import org.w3c.dom.ls.LSInput; +import org.w3c.dom.ls.LSResourceResolver; +import org.xml.sax.SAXException; +import org.xml.sax.SAXParseException; + +import ca.uhn.fhir.context.ConfigurationException; +import ca.uhn.fhir.context.FhirContext; +import ca.uhn.fhir.model.api.IResource; +import ca.uhn.fhir.model.dstu.resource.OperationOutcome.Issue; +import ca.uhn.fhir.model.dstu.valueset.IssueSeverityEnum; + +class SchemaBaseValidator implements IValidator { + private static final org.slf4j.Logger ourLog = org.slf4j.LoggerFactory.getLogger(SchemaBaseValidator.class); + + private Schema loadSchema(final IResource theResource, ValidationContext theValidationCtx) { + Source baseSource = loadXml(theValidationCtx, theResource, null, "fhir-single.xsd"); + + SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI); + schemaFactory.setResourceResolver(new LSResourceResolver() { + @Override + public LSInput resolveResource(String theType, String theNamespaceURI, String thePublicId, String theSystemId, String theBaseURI) { + if ("xml.xsd".equals(theSystemId) || "xhtml1-strict.xsd".equals(theSystemId)) { + LSInputImpl input = new LSInputImpl(); + input.setPublicId(thePublicId); + input.setSystemId(theSystemId); + input.setBaseURI(theBaseURI); + String pathToBase = theResource.getClass().getPackage().getName().replace('.', '/') + '/' + theSystemId; + InputStream baseIs = ResourceValidator.class.getClassLoader().getResourceAsStream(pathToBase); + if (baseIs == null) { + throw new ValidationFailureException("No FHIR-BASE schema found"); + } + + ourLog.debug("Loading schema: {}", theSystemId); + byte[] schema; + try { + schema = IOUtils.toByteArray(new InputStreamReader(baseIs, "UTF-8")); + } catch (IOException e) { + throw new ValidationFailureException("Failed to load schema " + theSystemId, e); + } + + // Account for BOM in UTF-8 text (this seems to choke Java 6's built in XML reader) + int offset = 0; + if (schema[0] == (byte) 0xEF && schema[1] == (byte) 0xBB && schema[2] == (byte) 0xBF) { + offset = 3; + } + + try { + input.setCharacterStream(new InputStreamReader(new ByteArrayInputStream(schema, offset, schema.length - offset), "UTF-8")); + } catch (UnsupportedEncodingException e) { + throw new ValidationFailureException("Failed to load schema " + theSystemId, e); + } + + return input; + + } + + throw new ConfigurationException("Unknown schema: " + theBaseURI); + } + }); + + Schema schema; + try { + schema = schemaFactory.newSchema(new Source[] { baseSource }); + } catch (SAXException e) { + throw new ConfigurationException("Could not load/parse schema file", e); + } + return schema; + } + + private Source loadXml(ValidationContext theCtx, IResource theResource, String theSystemId, String theSchemaName) { + Class baseResourceClass = theCtx.getFhirContext().getResourceDefinition(theResource).getBaseDefinition().getImplementingClass(); + Package pack = baseResourceClass.getPackage(); + String pathToBase = pack.getName().replace('.', '/') + '/' + theSchemaName; + InputStream baseIs = ResourceValidator.class.getClassLoader().getResourceAsStream(pathToBase); + if (baseIs == null) { + throw new ValidationFailureException("No FHIR-BASE schema found"); + } + Source baseSource = new StreamSource(baseIs, theSystemId); + return baseSource; + } + + @Override + public void validate(ValidationContext theContext) { + Schema schema = loadSchema(theContext.getOperationOutcome(), theContext); + try { + Validator validator = schema.newValidator(); + ErrorHandler handler = new ErrorHandler(theContext); + validator.setErrorHandler(handler); + validator.validate(new StreamSource(new StringReader(theContext.getXmlEncodedResource()))); + } catch (SAXException e) { + throw new ConfigurationException("Could not apply schema file", e); + } catch (IOException e) { + // This shouldn't happen since we're using a string source + throw new ConfigurationException("Could not load/parse schema file", e); + } + } + + public class ErrorHandler implements org.xml.sax.ErrorHandler { + + private ValidationContext myContext; + + public ErrorHandler(ValidationContext theContext) { + myContext = theContext; + } + + @Override + public void error(SAXParseException theException) throws SAXException { + addIssue(theException, IssueSeverityEnum.ERROR); + } + + @Override + public void fatalError(SAXParseException theException) throws SAXException { + addIssue(theException, IssueSeverityEnum.FATAL); + } + + @Override + public void warning(SAXParseException theException) throws SAXException { + addIssue(theException, IssueSeverityEnum.WARNING); + } + + private void addIssue(SAXParseException theException, IssueSeverityEnum severity) { + Issue issue = myContext.getOperationOutcome().addIssue(); + issue.setSeverity(severity); + issue.setDetails(theException.getLocalizedMessage()); + issue.addLocation().setValue("Line[" + theException.getLineNumber() + "] Col[" + theException.getColumnNumber() + "]"); + } + + } + +} diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/SchematronBaseValidator.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/SchematronBaseValidator.java new file mode 100644 index 00000000000..b19bf8ceef0 --- /dev/null +++ b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/SchematronBaseValidator.java @@ -0,0 +1,77 @@ +package ca.uhn.fhir.validation; + +import java.io.InputStream; +import java.io.StringReader; +import java.util.Locale; + +import javax.xml.transform.stream.StreamSource; + +import org.oclc.purl.dsdl.svrl.SchematronOutputType; + +import ca.uhn.fhir.context.RuntimeResourceDefinition; +import ca.uhn.fhir.model.api.IResource; +import ca.uhn.fhir.model.dstu.resource.OperationOutcome.Issue; +import ca.uhn.fhir.model.dstu.valueset.IssueSeverityEnum; + +import com.phloc.commons.error.IResourceError; +import com.phloc.commons.error.IResourceErrorGroup; +import com.phloc.schematron.ISchematronResource; +import com.phloc.schematron.SchematronHelper; +import com.phloc.schematron.xslt.SchematronResourceSCH; + +public class SchematronBaseValidator implements IValidator { + + @Override + public void validate(ValidationContext theCtx) { + + IResource resource = theCtx.getResource(); + RuntimeResourceDefinition baseDef = theCtx.getFhirContext().getResourceDefinition(resource).getBaseDefinition(); + Class baseResourceClass = baseDef.getImplementingClass(); + Package pack = baseResourceClass.getPackage(); + + String pathToBase = pack.getName().replace('.', '/') + '/' + baseDef.getName().toLowerCase() + ".sch"; + InputStream baseIs = ResourceValidator.class.getClassLoader().getResourceAsStream(pathToBase); + if (baseIs == null) { + throw new ValidationFailureException("No schematron found for resource type: " + baseDef.getImplementingClass().getCanonicalName()); + } + + ISchematronResource sch = SchematronResourceSCH.fromClassPath(pathToBase); + StreamSource source = new StreamSource(new StringReader(theCtx.getXmlEncodedResource())); + + SchematronOutputType results = SchematronHelper.applySchematron(sch, source); + if (results == null) { + return; + } + + IResourceErrorGroup errors = SchematronHelper.convertToResourceErrorGroup(results, baseDef.getName()); + + if (errors.getAllErrors().containsOnlySuccess()) { + return; + } + + for (IResourceError next : errors.getAllErrors().getAllResourceErrors()) { + Issue issue = theCtx.getOperationOutcome().addIssue(); + switch(next.getErrorLevel()) { + case ERROR: + issue.setSeverity(IssueSeverityEnum.ERROR); + break; + case FATAL_ERROR: + issue.setSeverity(IssueSeverityEnum.FATAL); + break; + case WARN: + issue.setSeverity(IssueSeverityEnum.WARNING); + break; + case INFO: + case SUCCESS: + continue; + } + + issue.getDetails().setValue(next.getAsString(Locale.getDefault())); + } + + } + + + + +} diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ValidationContext.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ValidationContext.java new file mode 100644 index 00000000000..873af7d5472 --- /dev/null +++ b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ValidationContext.java @@ -0,0 +1,41 @@ +package ca.uhn.fhir.validation; + +import ca.uhn.fhir.context.FhirContext; +import ca.uhn.fhir.model.api.IResource; +import ca.uhn.fhir.model.dstu.resource.OperationOutcome; + +class ValidationContext { + + private FhirContext myFhirContext; + private OperationOutcome myOperationOutcome; + private IResource myResource; + private String myXmlEncodedResource; + + public ValidationContext(FhirContext theContext, IResource theResource) { + myFhirContext = theContext; + myResource = theResource; + } + + public String getXmlEncodedResource() { + if (myXmlEncodedResource == null) { + myXmlEncodedResource = myFhirContext.newXmlParser().encodeResourceToString(myResource); + } + return myXmlEncodedResource; + } + + public OperationOutcome getOperationOutcome() { + if (myOperationOutcome == null) { + myOperationOutcome = new OperationOutcome(); + } + return myOperationOutcome; + } + + public FhirContext getFhirContext() { + return myFhirContext; + } + + public IResource getResource() { + return myResource; + } + +} diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ValidationFailureException.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ValidationFailureException.java new file mode 100644 index 00000000000..742ef206a2b --- /dev/null +++ b/hapi-fhir-base/src/main/java/ca/uhn/fhir/validation/ValidationFailureException.java @@ -0,0 +1,34 @@ +package ca.uhn.fhir.validation; + +import ca.uhn.fhir.model.dstu.resource.OperationOutcome; +import ca.uhn.fhir.model.dstu.valueset.IssueSeverityEnum; + +public class ValidationFailureException extends RuntimeException { + + private static final long serialVersionUID = 1L; + private OperationOutcome myOperationOutcome; + + public ValidationFailureException(String theProblem) { + this(theProblem, IssueSeverityEnum.FATAL, null); + } + + public ValidationFailureException(String theProblem, Exception theCause) { + this(theProblem, IssueSeverityEnum.FATAL, theCause); + } + + public ValidationFailureException(String theProblem, IssueSeverityEnum theSeverity, Exception theCause) { + super(theProblem, theCause); + myOperationOutcome = new OperationOutcome(); + myOperationOutcome.addIssue().setSeverity(theSeverity).setDetails(theProblem); + } + + public ValidationFailureException(String theProblem, OperationOutcome theOperationOutcome) { + super(theProblem); + myOperationOutcome = theOperationOutcome; + } + + public OperationOutcome getOperationOutcome() { + return myOperationOutcome; + } + +} diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/adversereaction.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/adversereaction.sch new file mode 100644 index 00000000000..82873ddf2e4 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/adversereaction.sch @@ -0,0 +1,33 @@ + + + + + + + AdverseReaction + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/alert.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/alert.sch new file mode 100644 index 00000000000..c9eb1db600b --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/alert.sch @@ -0,0 +1,30 @@ + + + + + + + Alert + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/allergyintolerance.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/allergyintolerance.sch new file mode 100644 index 00000000000..2633e41b5f0 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/allergyintolerance.sch @@ -0,0 +1,30 @@ + + + + + + + AllergyIntolerance + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/careplan.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/careplan.sch new file mode 100644 index 00000000000..947880c28ca --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/careplan.sch @@ -0,0 +1,90 @@ + + + + + + + CarePlan + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: Only provide a detail reference, or a simple detail summary + Inv-2: Quantity can only be specified if activity category is supply + Inv-1: DailyDose can only be specified if activity category is drug or food + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: There can only be a repeat element if there is none or one event + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-3: At most, only one of count or end can be present + Inv-2: Either frequency or when SHALL be present, but not both + + + Inv-4: duration SHALL be a positive value + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/composition.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/composition.sch new file mode 100644 index 00000000000..79e55e202f3 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/composition.sch @@ -0,0 +1,87 @@ + + + + + + + Composition + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: A section SHALL have content or one or more sections, but not both. + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/conceptmap.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/conceptmap.sch new file mode 100644 index 00000000000..931190cf731 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/conceptmap.sch @@ -0,0 +1,25 @@ + + + + + + + ConceptMap + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: If a code is provided, a system SHALL be provided + Inv-1: If the map is narrower, there SHALL be some comments + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/condition.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/condition.sch new file mode 100644 index 00000000000..038e73e8ead --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/condition.sch @@ -0,0 +1,123 @@ + + + + + + + Condition + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: Stage SHALL have summary or assessment + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: evidence SHALL have code or details + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: location SHALL have code or details + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-4: Relationship SHALL have either a code or a target + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/conformance.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/conformance.sch new file mode 100644 index 00000000000..c4bf03d18dc --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/conformance.sch @@ -0,0 +1,74 @@ + + + + + + + Conformance + + Inv-2: A Conformance statement SHALL have at least one of description, software, or implementation + Inv-1: A Conformance statement SHALL have at least one of rest, messaging or document + Inv-7: The set of documents must be unique by the combination of profile & mode + Inv-5: The set of end points listed for messaging must be unique + Inv-4: If there is more than one messaging element, endpoint must be specified for each one + Inv-8: There can only be one REST declaration per mode + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-10: A given query can only be described once per RESTful mode + Inv-9: A given resource can only be described once per RESTful mode + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-11: Operation codes must be unique in the context of a resource + Inv-12: Search parameter names must be unique in the context of a resource + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-13: Search parameter names must be unique in the context of a query + + + Inv-3: Messaging end point is required (and is only permitted) when statement is for an implementation + Inv-6: The set of events per messaging endpoint must be unique by the combination of code & mode + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/device.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/device.sch new file mode 100644 index 00000000000..42a9bbf4f0f --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/device.sch @@ -0,0 +1,39 @@ + + + + + + + Device + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/deviceobservationreport.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/deviceobservationreport.sch new file mode 100644 index 00000000000..145d5818db9 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/deviceobservationreport.sch @@ -0,0 +1,42 @@ + + + + + + + DeviceObservationReport + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/diagnosticorder.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/diagnosticorder.sch new file mode 100644 index 00000000000..ef321b07da1 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/diagnosticorder.sch @@ -0,0 +1,60 @@ + + + + + + + DiagnosticOrder + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/diagnosticreport.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/diagnosticreport.sch new file mode 100644 index 00000000000..189c6158367 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/diagnosticreport.sch @@ -0,0 +1,66 @@ + + + + + + + DiagnosticReport + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/documentmanifest.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/documentmanifest.sch new file mode 100644 index 00000000000..f2edd4a9cdb --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/documentmanifest.sch @@ -0,0 +1,54 @@ + + + + + + + DocumentManifest + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/documentreference.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/documentreference.sch new file mode 100644 index 00000000000..44b83181777 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/documentreference.sch @@ -0,0 +1,105 @@ + + + + + + + DocumentReference + + Inv-1: A location or a service (or both) SHALL be provided + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/encounter.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/encounter.sch new file mode 100644 index 00000000000..a8c7e226a97 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/encounter.sch @@ -0,0 +1,147 @@ + + + + + + + Encounter + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/familyhistory.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/familyhistory.sch new file mode 100644 index 00000000000..f130142bc99 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/familyhistory.sch @@ -0,0 +1,74 @@ + + + + + + + FamilyHistory + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: Quantity values cannot have a comparator when used in a Range + Inv-2: If present, low SHALL have a lower value than high + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: Quantity values cannot have a comparator when used in a Range + Inv-2: If present, low SHALL have a lower value than high + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/fhir-all.xsd b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/fhir-all.xsd new file mode 100644 index 00000000000..048cad7dede --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/fhir-all.xsd @@ -0,0 +1,82 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/fhir-single.xsd b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/fhir-single.xsd new file mode 100644 index 00000000000..c486ae52c50 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/fhir-single.xsd @@ -0,0 +1,12358 @@ + + + + + + + + + + + + + + + The base element used for all FHIR elements and resources - allows for them to be extended with extensions + + + + + An extension - additional local content. The extension URL defines it's meaning + + + + + + + + + An element defined in a FHIR resources - can have modifierExtension elements + + + + + + + An extension that modifies the meaning of the element that contains it - additional local content. The extension URL defines it's meaning + + + + + + + + + + + + + + A whole number + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + + + + + + A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds may be provided but may also be ignored. Dates SHALL be valid dates. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + + + A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents + If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions + + + + + + + + + + + + + + + + + + A date, or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + A rational number with implicit precision + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + String of characters used to identify a name or a resource + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + + + + A whole number in the range 0 to 2^64-1, optionally represented in hex, a uuid, an oid or any other combination of lower-case letters a-z, numerals, "-" and ".", with a length limit of 36 characters + If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions + + + + + + + + + + + + + A stream of bytes + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + + + + An oid represented as a URI + If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions + + + + + + + + + + + + + + + A sequence of Unicode characters + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + Value of "true" or "false" + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + + + + A UUID, represented as a URI + If the element is present, it must have either a @value, an @id referenced from the Narrative, or extensions + + + + + + + + + + + + + An instant in time - known at least to the second + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance. + + + + + Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary. + + + + + Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions. + + + + + A supply - a request for something, and provision of what is supplied. + + + + + This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. + + + + + A description of a query with a set of parameters. + + + + + A request to perform an action. + + + + + A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc. + + + + + An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy. + + + + + A homogeneous material with a definite composition. + + + + + The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports. + + + + + Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization. + + + + + A value set specifies a set of codes drawn from one or more code systems. + + + + + Primarily used for identification and definition of Medication, but also covers ingredients and packaging. + + + + + The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. + + + + + A patient's point-of-time immunization status and recommendation with optional supporting justification. + + + + + A manifest that defines a set of documents. + + + + + Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication. + + + + + An order for both supply of the medication and the instructions for administration of the medicine to a patient. + + + + + Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. + +Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. + + + + + An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. + + + + + A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. + + + + + A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician. + + + + + A set of information summarized from a list of other resources. + + + + + A structured set of questions and their answers. The Questionnaire may contain questions, answers or both. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions. + + + + + A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. + + + + + Describes the data produced by a device at a point in time. + + + + + A collection of error, warning or information messages that result from a system action. + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. + + + + + Significant health events and conditions for people related to the subject relevant in the context of care for the subject. + + + + + Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest. + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated. + + + + + Measurements and simple assertions made about a patient, device or other subject. + + + + + Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance. + + + + + A reference to a document. + + + + + Immunization event information. + + + + + Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. + + + + + Sample for analysis. + + + + + A response to an order. + + + + + Prospective warnings of potential issues when providing care to the patient. + + + + + A statement of relationships from one set of concepts to one or more other concept systems. + + + + + Demographics and other administrative information about a person or animal receiving care or other health-related services. + + + + + A person who is directly or indirectly involved in the provisioning of healthcare. + + + + + Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance. + + + + + Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images. + + + + + A request for a diagnostic investigation service to be performed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The base resource declaration used for all FHIR resource types - adds Narrative and xml:lang + + + + + + + The human language of the content. The value can be any valid value according to BCP-47 + + + + + Text summary of resource content (for human interpretation) + + + + + Contained, inline Resources. These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope + + + + + + + + + + Optional Extensions Element - found in all resources. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A human-readable formatted text, including images. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. + + + + + The actual narrative content, a stripped down version of XHTML. + + + + + + + + + + + The contents of the narrative are entirely generated from the structured data in the resource. + + + + + The contents of the narrative are entirely generated from the structured data in the resource and some of the content is generated from extensions. + + + + + The contents of the narrative contain additional information not found in the structured data. + + + + + the contents of the narrative are some equivalent of "No human-readable text provided for this resource". + + + + + + + The status of a resource narrative + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A time period defined by a start and end date and optionally time. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + The start of the period. The boundary is inclusive. + + + + + The end of the period. If the end of the period is missing, it means that the period is ongoing. + + + + + + + + + A reference to a code defined by a terminology system. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + The identification of the code system that defines the meaning of the symbol in the code. + + + + + The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. + + + + + A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). + + + + + A representation of the meaning of the code in the system, following the rules of the system. + + + + + Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays). + + + + + The set of possible coded values this coding was chosen from or constrained by. + + + + + + + + + A set of ordered Quantities defined by a low and high limit. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + The low limit. The boundary is inclusive. + + + + + The high limit. The boundary is inclusive. + + + + + + + + + A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + The value of the measured amount. The value includes an implicit precision in the presentation of the value. + + + + + How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues. E.g. if the comparator is "<" , then the real value is < stated value. + + + + + A human-readable form of the units. + + + + + The identification of the system that provides the coded form of the unit. + + + + + A computer processable form of the units in some unit representation system. + + + + + + + + + + + The actual value is less than the given value. + + + + + The actual value is less than or equal to the given value. + + + + + The actual value is greater than or equal to the given value. + + + + + The actual value is greater than the given value. + + + + + + + How the Quantity should be understood and represented + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + For referring to data content defined in other formats. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. + + + + + The human language of the content. The value can be any valid value according to BCP 47. + + + + + The actual data of the attachment - a sequence of bytes. In XML, represented using base64. + + + + + An alternative location where the data can be accessed. + + + + + The number of bytes of data that make up this attachment. + + + + + The calculated hash of the data using SHA-1. Represented using base64. + + + + + A label or set of text to display in place of the data. + + + + + + + + + A relationship of two Quantity values - expressed as a numerator and a denominator. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + The value of the numerator. + + + + + The value of the denominator. + + + + + + + + + A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series. + + + + + The length of time between sampling times, measured in milliseconds. + + + + + A correction factor that is applied to the sampled data points before they are added to the origin. + + + + + The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit). + + + + + The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit). + + + + + The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once. + + + + + A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value. + + + + + + + + + + + + + + + + + + + + + + A reference from one resource to another. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + A reference to a location at which the other resource is found. The reference may a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. + + + + + Plain text narrative that identifies the resource in addition to the resource reference. + + + + + + + + + A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + A reference to a code defined by a terminology system. + + + + + A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. + + + + + + + + + A technical identifier - identifies some entity uniquely and unambiguously. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + The purpose of this identifier. + + + + + A text string for the identifier that can be displayed to a human so they can recognize the identifier. + + + + + Establishes the namespace in which set of possible id values is unique. + + + + + The portion of the identifier typically displayed to the user and which is unique within the context of the system. + + + + + Time period during which identifier is/was valid for use. + + + + + Organization that issued/manages the identifier. + + + + + + + + + + + the identifier recommended for display and use in real-world interactions. + + + + + the identifier considered to be most trusted for the identification of this item. + + + + + A temporary identifier. + + + + + An identifier that was assigned in secondary use - it serves to identify the object in a relative context, but cannot be consistently assigned to the same object again in a different context. + + + + + + + Identifies the purpose for this identifier, if known + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + + The value of the measured amount. The value includes an implicit precision in the presentation of the value. + + + + + How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues. E.g. if the comparator is "<" , then the real value is < stated value. + + + + + A human-readable form of the units. + + + + + The identification of the system that provides the coded form of the unit. + + + + + A computer processable form of the units in some unit representation system. + + + + + + + + + + + + + + The value of the measured amount. The value includes an implicit precision in the presentation of the value. + + + + + How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues. E.g. if the comparator is "<" , then the real value is < stated value. + + + + + A human-readable form of the units. + + + + + The identification of the system that provides the coded form of the unit. + + + + + A computer processable form of the units in some unit representation system. + + + + + + + + + + + + + + The value of the measured amount. The value includes an implicit precision in the presentation of the value. + + + + + How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues. E.g. if the comparator is "<" , then the real value is < stated value. + + + + + A human-readable form of the units. + + + + + The identification of the system that provides the coded form of the unit. + + + + + A computer processable form of the units in some unit representation system. + + + + + + + + + + + + + + The value of the measured amount. The value includes an implicit precision in the presentation of the value. + + + + + How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues. E.g. if the comparator is "<" , then the real value is < stated value. + + + + + A human-readable form of the units. + + + + + The identification of the system that provides the coded form of the unit. + + + + + A computer processable form of the units in some unit representation system. + + + + + + + + + + + + + + The value of the measured amount. The value includes an implicit precision in the presentation of the value. + + + + + How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues. E.g. if the comparator is "<" , then the real value is < stated value. + + + + + A human-readable form of the units. + + + + + The identification of the system that provides the coded form of the unit. + + + + + A computer processable form of the units in some unit representation system. + + + + + + + + + + Specifies an event that may occur multiple times. Schedules are used for to reord when things are expected or requested to occur. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + Identifies specific time periods when the event should occur. + + + + + Identifies a repeating pattern to the intended time periods. + + + + + + + + + Specifies an event that may occur multiple times. Schedules are used for to reord when things are expected or requested to occur. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + Indicates how often the event should occur. + + + + + Identifies the occurrence of daily life that determines timing. + + + + + How long each repetition should last. + + + + + The units of time for the duration. + + + + + A total count of the desired number of repetitions. + + + + + When to stop repeating the schedule. + + + + + + + + + + + event occurs [duration] before the hour of sleep (or trying to). + + + + + event occurs [duration] after waking. + + + + + event occurs [duration] before a meal (from the Latin ante cibus). + + + + + event occurs [duration] before breakfast (from the Latin ante cibus matutinus). + + + + + event occurs [duration] before lunch (from the Latin ante cibus diurnus). + + + + + event occurs [duration] before dinner (from the Latin ante cibus vespertinus). + + + + + event occurs [duration] after a meal (from the Latin post cibus). + + + + + event occurs [duration] after breakfast (from the Latin post cibus matutinus). + + + + + event occurs [duration] after lunch (from the Latin post cibus diurnus). + + + + + event occurs [duration] after dinner (from the Latin post cibus vespertinus). + + + + + + + Real world event that the schedule relates to + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + second. + + + + + minute. + + + + + hour. + + + + + day. + + + + + week. + + + + + month. + + + + + year. + + + + + + + A unit of time (units from UCUM) + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + All kinds of technology mediated contact details for a person or organization, including telephone, email, etc. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + Telecommunications form for contact - what communications system is required to make use of the contact. + + + + + The actual contact details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). + + + + + Identifies the purpose for the address. + + + + + Time period when the contact was/is in use. + + + + + + + + + + + The value is a telephone number used for voice calls. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required. + + + + + The value is a fax machine. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required. + + + + + The value is an email address. + + + + + The value is a url. This is intended for various personal contacts including blogs, Twitter, Facebook, etc. Do not use for email addresses. + + + + + + + Telecommunications form for contact + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + A communication contact at a home; attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available. + + + + + An office contact. First choice for business related contacts during business hours. + + + + + A temporary contact. The period can provide more detailed information. + + + + + This contact is no longer in use (or was never correct, but retained for records). + + + + + A telecommunication device that moves and stays with its owner. May have characteristics of all other use codes, suitable for urgent matters, not the first choice for routine business. + + + + + + + Location, type or status of telecommunications address indicating use + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + The purpose of this address. + + + + + A full text representation of the address. + + + + + This component contains the house number, apartment number, street name, street direction, +P.O. Box number, delivery hints, and similar address information. + + + + + The name of the city, town, village or other community or delivery center. + + + + + Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). + + + + + A postal code designating a region defined by the postal service. + + + + + Country - a nation as commonly understood or generally accepted. + + + + + Time period when address was/is in use. + + + + + + + + + + + A communication address at a home. + + + + + An office address. First choice for business related contacts during business hours. + + + + + A temporary address. The period can provide more detailed information. + + + + + This address is no longer in use (or was never correct, but retained for records). + + + + + + + The use of an address + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A human's name with the ability to identify parts and usage. + If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions + + + + + + + Identifies the purpose for this name. + + + + + A full text representation of the name. + + + + + The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. + + + + + Given name. + + + + + Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. + + + + + Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. + + + + + Indicates the period of time when this name was valid for the named person. + + + + + + + + + + + Known as/conventional/the one you normally use. + + + + + The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name". + + + + + A temporary name. Name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations. + + + + + A name that is used to address the person in an informal manner, but is not part of their formal or usual name. + + + + + Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons). + + + + + This name is no longer in use (or was never correct, but retained for records). + + + + + A name used prior to marriage. Marriage naming customs vary greatly around the world. This name use is for use by applications that collect and store "maiden" names. Though the concept of maiden name is often gender specific, the use of this term is not gender specific. The use of this term does not imply any particular history for a person's name, nor should the maiden name be determined algorithmically. + + + + + + + The use of a human name + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + This is the current reference for this document. + + + + + This reference has been superseded by another reference. + + + + + This reference was created in error. + + + + + + + + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Search parameter SHALL be a number (a whole number, or a decimal). + + + + + Search parameter is on a date/time. The date format is the standard XML format, though other formats may be supported. + + + + + Search parameter is a simple string, like a name part. Search is case-insensitive and accent-insensitive. May match just the start of a string. String parameters may contain spaces. + + + + + Search parameter on a coded element or identifier. May be used to search through the text, displayname, code and code/codesystem (for codes) and label, system and key (for identifier). Its value is either a string or a pair of namespace and value, separated by a "|", depending on the modifier used. + + + + + A reference to another resource. + + + + + A composite search parameter that combines a search on two values together. + + + + + A search parameter that searches on a quantity. + + + + + + + + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + This valueset is still under development. + + + + + This valueset is ready for normal use. + + + + + This valueset has been withdrawn or superceded and should no longer be used. + + + + + + + + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + + + + + + + + + + + + + + + + Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance. + + + + + Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + This records identifiers associated with this reaction that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). + + + + + The date (and possibly time) when the reaction began. + + + + + The subject of the adverse reaction. + + + + + If true, indicates that no reaction occurred. + + + + + Identifies the individual responsible for the information in the reaction record. + + + + + The signs and symptoms that were observed as part of the reaction. + + + + + An exposure to a substance that preceded a reaction occurrence. + + + + + + + + + Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance. + + + + + + + Indicates the specific sign or symptom that was observed. + + + + + The severity of the sign or symptom. + + + + + + + + + Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance. + + + + + + + Identifies the initial date of the exposure that is suspected to be related to the reaction. + + + + + The type of exposure: Drug Administration, Immunization, Coincidental. + + + + + A statement of how confident that the recorder was that this exposure caused the reaction. + + + + + Substance that is presumed to have caused the adverse reaction. + + + + + + + + + + + Severe complications arose due to the reaction. + + + + + Serious inconvenience to the subject. + + + + + Moderate inconvenience to the subject. + + + + + Minor inconvenience to the subject. + + + + + + + The severity of an adverse reaction. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Drug Administration. + + + + + Immunization. + + + + + In the same area as the substance. + + + + + + + The type of exposure that resulted in an adverse reaction + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Likely that this specific exposure caused the reaction. + + + + + Unlikely that this specific exposure caused the reaction - the exposure is being linked to for information purposes. + + + + + It has been confirmed that this exposure was one of the causes of the reaction. + + + + + It is unknown whether this exposure had anything to do with the reaction. + + + + + + + How likely is it that the given exposure caused a reaction + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Prospective warnings of potential issues when providing care to the patient. + + + + + Prospective warnings of potential issues when providing care to the patient. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Identifier assigned to the alert for external use (outside the FHIR environment). + + + + + Allows an alert to be divided into different categories like clinical, administrative etc. + + + + + Supports basic workflow. + + + + + The person who this alert concerns. + + + + + The person or device that created the alert. + + + + + The textual component of the alert to display to the user. + + + + + + + + + + + A current alert that should be displayed to a user. A system may use the category to determine which roles should view the alert. + + + + + The alert does not need to be displayed any more. + + + + + The alert was added in error, and should no longer be displayed. + + + + + + + Indicates whether this alert is active and needs to be displayed to a user, or whether it is no longer needed or entered in error + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance. + + + + + Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + This records identifiers associated with this allergy/intolerance concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). + + + + + Criticality of the sensitivity. + + + + + Type of the sensitivity. + + + + + Date when the sensitivity was recorded. + + + + + Status of the sensitivity. + + + + + The patient who has the allergy or intolerance. + + + + + Indicates who has responsibility for the record. + + + + + The substance that causes the sensitivity. + + + + + Reactions associated with the sensitivity. + + + + + Observations that confirm or refute the sensitivity. + + + + + + + + + + + A suspected sensitivity to a substance. + + + + + The sensitivity has been confirmed and is active. + + + + + The sensitivity has been shown to never have existed. + + + + + The sensitivity used to exist but no longer does. + + + + + + + The status of the adverse sensitivity + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Likely to result in death if re-exposed. + + + + + Likely to result in reactions that will need to be treated if re-exposed. + + + + + Likely to result in reactions that will inconvenience the subject. + + + + + Not likely to result in any inconveniences for the subject. + + + + + + + The criticality of an adverse sensitivity + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Allergic Reaction. + + + + + Non-Allergic Reaction. + + + + + Unknown type. + + + + + + + The type of an adverse sensitivity + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions. + + + + + Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + This records identifiers associated with this care plan that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). + + + + + Identifies the patient/subject whose intended care is described by the plan. + + + + + Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record. + + + + + Indicates when the plan did (or is intended to) come into effect and end. + + + + + Identifies the most recent date on which the plan has been revised. + + + + + Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. + + + + + Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. + + + + + Describes the intended objective(s) of carrying out the Care Plan. + + + + + Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc. + + + + + General notes about the care plan not covered elsewhere. + + + + + + + + + Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions. + + + + + + + Indicates specific responsibility of an individual within the care plan. E.g. "Primary physician", "Team coordinator", "Caregiver", etc. + + + + + The specific person or organization who is participating/expected to participate in the care plan. + + + + + + + + + Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions. + + + + + + + Human-readable description of a specific desired objective of the care plan. + + + + + Indicates whether the goal has been reached and is still considered relevant. + + + + + Any comments related to the goal. + + + + + The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address. + + + + + + + + + Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions. + + + + + + + Internal reference that identifies the goals that this activity is intended to contribute towards meeting. + + + + + Identifies what progress is being made for the specific activity. + + + + + If true, indicates that the described activity is one that must NOT be engaged in when following the plan. + + + + + Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc. + + + + + Notes about the execution of the activity. + + + + + The details of the proposed activity represented in a specific resource. + + + + + A simple summary of details suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc. + + + + + + + + + Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions. + + + + + + + High-level categorization of the type of activity in a care plan. + + + + + Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter. + + + + + The period, timing or frequency upon which the described activity is to occur. + + + + + + + + Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc. + + + + + Identifies who's expected to be involved in the activity. + + + + + Identifies the food, drug or other product being consumed or supplied in the activity. + + + + + Identifies the quantity expected to be consumed in a given day. + + + + + Identifies the quantity expected to be supplied. + + + + + This provides a textual description of constraints on the activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc. + + + + + + + + + + + The plan is in development or awaiting use but is not yet intended to be acted upon. + + + + + The plan is intended to be followed and used as part of patient care. + + + + + The plan is no longer in use and is not expected to be followed or used in patient care. + + + + + + + Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Plan for the patient to consume food of a specified nature. + + + + + Plan for the patient to consume/receive a drug, vaccine or other product. + + + + + Plan to meet or communicate with the patient (in-patient, out-patient, phone call, etc.). + + + + + Plan to capture information about a patient (vitals, labs, diagnostic images, etc.). + + + + + Plan to modify the patient in some way (surgery, physiotherapy, education, counseling, etc.). + + + + + Plan to provide something to the patient (medication, medical supply, etc.). + + + + + Some other form of action. + + + + + + + High-level categorization of the type of activity in a care plan. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The goal is being sought but has not yet been reached. (Also applies if goal was reached in the past but there has been regression and goal is being sought again). + + + + + The goal has been met and no further action is needed. + + + + + The goal has been met, but ongoing activity is needed to sustain the goal objective. + + + + + The goal is no longer being sought. + + + + + + + Indicates whether the goal has been met and is still being targeted + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Activity is planned but no action has yet been taken. + + + + + Appointment or other booking has occurred but activity has not yet begun. + + + + + Activity has been started but is not yet complete. + + + + + Activity was started but has temporarily ceased with an expectation of resumption at a future time. + + + + + The activities have been completed (more or less) as planned. + + + + + The activities have been ended prior to completion (perhaps even before they were started). + + + + + + + Indicates where the activity is at in its overall life cycle + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. + + + + + A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Logical Identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time. + + + + + The composition editing time, when the composition was last logically changed by the author. + + + + + Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition. + + + + + A categorization for the type of the composition. This may be implied by or derived from the code specified in the Composition Type. + + + + + Official human-readable label for the composition. + + + + + The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. + + + + + The code specifying the level of confidentiality of the Composition. + + + + + Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). + + + + + Identifies who is responsible for the information in the composition. (Not necessarily who typed it in.). + + + + + A participant who has attested to the accuracy of the composition/document. + + + + + Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. + + + + + The main event/act/item, such as a colonoscopy or an appendectomy, being documented. + + + + + Describes the clinical encounter or type of care this documentation is associated with. + + + + + The root of the sections that make up the composition. + + + + + + + + + A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. + + + + + + + The type of attestation the authenticator offers. + + + + + When composition was attested by the party. + + + + + Who attested the composition in the specified way. + + + + + + + + + A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. + + + + + + + This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. + + + + + The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time. + + + + + Full details for the event(s) the composition/documentation consents. + + + + + + + + + A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. + + + + + + + The heading for this particular section. This will be part of the rendered content for the document. + + + + + A code identifying the kind of content contained within the section. + + + + + Identifies the primary subject of the section. + + + + + Identifies the discrete data that provides the content for the section. + + + + + A nested sub-section within this section. + + + + + + + + + + + This is a preliminary composition or document (also known as initial or interim). The content may be incomplete or unverified. + + + + + The composition or document is complete and verified by an appropriate person, and no further work is planned. + + + + + The composition or document has been modified subsequent to being released as "final", and is complete and verified by an authorized person. The modifications added new information to the composition or document, but did not revise existing content. + + + + + The composition or document has been modified subsequent to being released as "final", and is complete and verified by an authorized person. + + + + + The composition or document was originally created/issued in error, and this is an amendment that marks that the entire series should not be considered as valid. + + + + + + + The workflow/clinical status of the composition + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The person authenticated the content in their personal capacity. + + + + + The person authenticated the content in their professional capacity. + + + + + The person authenticated the content and accepted legal responsibility for its content. + + + + + The organization authenticated the content as consistent with their policies and procedures. + + + + + + + The way in which a person authenticated a composition + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A statement of relationships from one set of concepts to one or more other concept systems. + + + + + A statement of relationships from one set of concepts to one or more other concept systems. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + The identifier that is used to identify this concept map when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI). + + + + + The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp. + + + + + A free text natural language name describing the concept map. + + + + + The name of the individual or organization that published the concept map. + + + + + Contacts of the publisher to assist a user in finding and communicating with the publisher. + + + + + A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc. + + + + + A copyright statement relating to the concept map and/or its contents. + + + + + The status of the concept map. + + + + + This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. + + + + + The date that the concept map status was last changed. + + + + + The source value set that specifies the concepts that are being mapped. + + + + + The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made. + + + + + Mappings for a concept from the source valueset. + + + + + + + + + A statement of relationships from one set of concepts to one or more other concept systems. + + + + + + + System that defines the concept being mapped. + + + + + Identifies concept being mapped. + + + + + A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified concept can be resolved, and it has the specified value. + + + + + A concept from the target value set that this concept maps to. + + + + + + + + + A statement of relationships from one set of concepts to one or more other concept systems. + + + + + + + A reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition. + + + + + System for a concept in the referenced concept. + + + + + Code for a concept in the referenced concept. + + + + + + + + + A statement of relationships from one set of concepts to one or more other concept systems. + + + + + + + System of the target. + + + + + Code that identifies the target concept. + + + + + equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint. + + + + + Description of status/issues in mapping. + + + + + A set of additional outcomes from this mapping to other value sets. To properly execute this mapping, the specified value set must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on. + + + + + + + + + + + The definitions of the concepts are exactly the same (i.e. only grammatical differences) and structural implications of meaning are identifical or irrelevant (i.e. intensionally identical). + + + + + The definitions of the concepts mean the same thing (including when structural implications of meaning are considered) (i.e. extensionally identical). + + + + + The target mapping is wider in meaning than the source concept. + + + + + The target mapping subsumes the meaning of the source concept (e.g. the source is-a target). + + + + + The target mapping is narrower in meaning that the source concept. The sense in which the mapping is narrower SHALL be described in the comments in this case, and applications should be careful when atempting to use these mappings operationally. + + + + + The target mapping specialises the meaning of the source concept (e.g. the target is-a source). + + + + + The target mapping overlaps with the source concept, but both source and target cover additional meaning. The sense in which the mapping is narrower SHALL be described in the comments in this case, and applications should be careful when atempting to use these mappings operationally. + + + + + There is no match for this concept in the destination concept system. + + + + + This is an explicit assertion that there is no mapping between the source and target concept. + + + + + + + The degree of equivalence between concepts + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary. + + + + + Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + This records identifiers associated with this condition that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). + + + + + Indicates the patient who the condition record is associated with. + + + + + Encounter during which the condition was first asserted. + + + + + Person who takes responsibility for asserting the existence of the condition as part of the electronic record. + + + + + Estimated or actual date the condition/problem/diagnosis was first detected/suspected. + + + + + Identification of the condition, problem or diagnosis. + + + + + A category assigned to the condition. E.g. complaint | symptom | finding | diagnosis. + + + + + The clinical status of the condition. + + + + + The degree of confidence that this condition is correct. + + + + + A subjective assessment of the severity of the condition as evaluated by the clinician. + + + + + Estimated or actual date the condition began, in the opinion of the clinician. + + + + + + + The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate. + + + + + + + + Clinical stage or grade of a condition. May include formal severity assessments. + + + + + Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed. + + + + + The anatomical location where this condition manifests itself. + + + + + Further conditions, problems, diagnoses, procedures or events that are related in some way to this condition, or the substance that caused/triggered this Condition. + + + + + Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis. + + + + + + + + + Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary. + + + + + + + A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific. + + + + + Reference to a formal record of the evidence on which the staging assessment is based. + + + + + + + + + Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary. + + + + + + + A manifestation or symptom that led to the recording of this condition. + + + + + Links to other relevant information, including pathology reports. + + + + + + + + + Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary. + + + + + + + Code that identifies the structural location. + + + + + Detailed anatomical location information. + + + + + + + + + Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary. + + + + + + + The type of relationship that this condition has to the related item. + + + + + Code that identifies the target of this relationship. The code takes the place of a detailed instance target. + + + + + Target of the relationship. + + + + + + + + + + + This is a tentative diagnosis - still a candidate that is under consideration. + + + + + The patient is being treated on the basis that this is the condition, but it is still not confirmed. + + + + + There is sufficient diagnostic and/or clinical evidence to treat this as a confirmed condition. + + + + + This condition has been ruled out by diagnostic and clinical evidence. + + + + + + + The clinical status of the Condition or diagnosis + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + this condition follows the identified condition/procedure/substance and is a consequence of it. + + + + + this condition follows the identified condition/procedure/substance, but it is not known whether they are causually linked. + + + + + + + The type of relationship between a condition and its related item + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + The identifier that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI). + + + + + The identifier that is used to identify this version of the conformance statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp. + + + + + A free text natural language name identifying the conformance statement. + + + + + Name of Organization publishing this conformance statement. + + + + + Contacts for Organization relevant to this conformance statement. The contacts may be a website, email, phone numbers, etc. + + + + + A free text natural language description of the conformance statement and its use. Typically, this is used when the profile describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP. + + + + + The status of this conformance statement. + + + + + A flag to indicate that this conformance statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. + + + + + The date when the conformance statement was published. + + + + + Software that is covered by this conformance statement. It is used when the profile describes the capabilities of a particular software version, independent of an installation. + + + + + Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program. + + + + + The version of the FHIR specification on which this conformance statement is based. + + + + + A flag that indicates whether the application accepts unknown elements as part of a resource. + + + + + A list of the formats supported by this implementation. + + + + + A list of profiles supported by the system. For a server, "supported by the system" means the system hosts/produces a set of recourses, conformant to a particular profile, and allows its clients to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. + + + + + A definition of the restful capabilities of the solution, if any. + + + + + A description of the messaging capabilities of the solution. + + + + + A document definition. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + Name software is known by. + + + + + The version identifier for the software covered by this statement. + + + + + Date this version of the software released. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + Information about the specific installation that this conformance statement relates to. + + + + + A base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + Identifies whether this portion of the statement is describing ability to initiate or receive restful operations. + + + + + Information about the system's restful capabilities that apply across all applications, such as security. + + + + + Information about security of implementation. + + + + + A specification of the restful capabilities of the solution for a specific resource type. + + + + + A specification of restful operations supported by the system. + + + + + Definition of a named query and its parameters and their meaning. + + + + + A list of profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier "http://hl7.org/fhir/documents/mailbox". Other specifications can declare their own identifier for this purpose. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + Server adds CORS headers when responding to requests - this enables javascript applications to yuse the server. + + + + + Types of security services are supported/required by the system. + + + + + General description of how security works. + + + + + Certificates associated with security profiles. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + Mime type for certificate. + + + + + Actual certificate. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + A type of resource exposed via the restful interface. + + + + + A specification of the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. + + + + + Identifies a restful operation supported by the solution. + + + + + A flag for whether the server is able to return past versions as part of the vRead operation. + + + + + A flag to indicate that the server allows the client to create new identities on the server. If the update operation is used (client) or allowed (server) to a new location where a resource doesn't already exist. This means that the server allows the client to create new identities on the server. + + + + + A list of _include values supported by the server. + + + + + Additional search parameters for implementations to support and/or make use of. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + Coded identifier of the operation, supported by the system resource. + + + + + Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + The name of the search parameter used in the interface. + + + + + A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter. + + + + + The type of value a search parameter refers to, and how the content is interpreted. + + + + + This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms. + + + + + Types of resource (if a resource is referenced). + + + + + Chained names supported. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + A coded identifier of the operation, supported by the system. + + + + + Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + The name of a query, which is used in the _query parameter when the query is called. + + + + + Identifies the custom query, defined either in FHIR core or another profile. + + + + + Additional information about how the query functions in this particular implementation. + + + + + Identifies which of the parameters for the named query are supported. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + An address to which messages and/or replies are to be sent. + + + + + Length if the receiver's reliable messaging cache (if a receiver) or how long the cache length on the receiver should be (if a sender). + + + + + Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the conformance statement. For example, process for becoming an authorized messaging exchange partner. + + + + + A description of the solution's support for an event at this end point. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + A coded identifier of a supported messaging event. + + + + + The impact of the content of the message. + + + + + The mode of this event declaration - whether application is sender or receiver. + + + + + A list of the messaging transport protocol(s) identifiers, supported by this endpoint. + + + + + A resource associated with the event. This is the resource that defines the event. + + + + + Information about the request for this event. + + + + + Information about the response for this event. + + + + + Guidance on how this event is handled, such as internal system trigger points, business rules, etc. + + + + + + + + + A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation. + + + + + + + Mode of this document declaration - whether application is producer or consumer. + + + + + A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc. + + + + + A constraint on a resource used in the document. + + + + + + + + + + + The application produces documents of the specified type. + + + + + The application consumes documents of the specified type. + + + + + + + Whether the application produces or consumes documents + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The application acts as a server for this resource. + + + + + The application acts as a client for this resource. + + + + + + + The mode of a RESTful conformance statement + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The application sends requests and receives responses. + + + + + The application receives requests and sends responses. + + + + + + + The mode of a message conformance statement + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The message represents/requests a change that should not be processed more than once. E.g. Making a booking for an appointment. + + + + + The message represents a response to query for current information. Retrospective processing is wrong and/or wasteful. + + + + + The content is not necessarily intended to be current, and it can be reprocessed, though there may be version issues created by processing old notifications. + + + + + + + The impact of the content of a message + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Operations supported by REST at the type or instance level + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + This conformance statement is still under development. + + + + + This conformance statement is ready for use in production systems. + + + + + This conformance statement has been withdrawn or superceded and should no longer be used. + + + + + + + The status of this conformance statement + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Operations supported by REST at the system level + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. + + + + + This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Identifiers assigned to this device by various organizations. The most likely organizations to assign identifiers are the manufacturer and the owner, though regulatory agencies may also assign an identifier. The identifiers identify the particular device, not the kind of device. + + + + + A kind of this device. + + + + + A name of the manufacturer. + + + + + The "model" - an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type. + + + + + The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware. + + + + + Date of expiry of this device (if applicable). + + + + + FDA Mandated Unique Device Identifier. Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm. + + + + + Lot number assigned by the manufacturer. + + + + + An organization that is responsible for the provision and ongoing maintenance of the device. + + + + + The resource may be found in a literal location (i.e. GPS coordinates), a logical place (i.e. "in/with the patient"), or a coded location. + + + + + Patient information, if the resource is affixed to a person. + + + + + Contact details for an organization or a particular human that is responsible for the device. + + + + + A network address on which the device may be contacted directly. + + + + + + + + + Describes the data produced by a device at a point in time. + + + + + Describes the data produced by a device at a point in time. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + The point in time that the values are reported. + + + + + An identifier assigned to this observation bu the source device that made the observation. + + + + + Identification information for the device that is the source of the data. + + + + + The subject of the measurement. + + + + + A medical-related subsystem of a medical device. + + + + + + + + + Describes the data produced by a device at a point in time. + + + + + + + Describes the compartment. + + + + + Groups together physiological measurement data and derived data. + + + + + + + + + Describes the data produced by a device at a point in time. + + + + + + + Describes the channel. + + + + + A piece of measured or derived data that is reported by the machine. + + + + + + + + + Describes the data produced by a device at a point in time. + + + + + + + The data for the metric. + + + + + + + + + A request for a diagnostic investigation service to be performed. + + + + + A request for a diagnostic investigation service to be performed. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Who or what the investigation is to be performed on. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). + + + + + The practitioner that holds legal responsibility for ordering the investigation. + + + + + Identifiers assigned to this order by the order or by the receiver. + + + + + An encounter that provides additional informaton about the healthcare context in which this request is made. + + + + + An explanation or justification for why this diagnostic investigation is being requested. + + + + + One or more specimens that the diagnostic investigation is about. + + + + + The status of the order. + + + + + The clinical priority associated with this order. + + + + + A summary of the events of interest that have occurred as the request is processed. E.g. when the order was made, various processing steps (specimens received), when it was completed. + + + + + The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested. + + + + + + + + + A request for a diagnostic investigation service to be performed. + + + + + + + The status for the event. + + + + + Additional information about the event that occurred - e.g. if the status remained unchanged. + + + + + The date/time at which the event occurred. + + + + + The person who was responsible for performing or recording the action. + + + + + + + + + A request for a diagnostic investigation service to be performed. + + + + + + + A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested. + + + + + If the item is related to a specific speciment. + + + + + Anatomical location where the request test should be performed. + + + + + The status of this individual item within the order. + + + + + A summary of the events of interest that have occurred as this item of the request is processed. + + + + + + + + + + + The request has been placed. + + + + + The receiving system has received the order, but not yet decided whether it will be performed. + + + + + The receiving system has accepted the order, but work has not yet commenced. + + + + + The work to fulfill the order is happening. + + + + + The work is complete, and the outcomes are being reviewed for approval. + + + + + The work has been complete, the report(s) released, and no further work is planned. + + + + + The request has been held by originating system/user request. + + + + + The receiving system has declined to fulfill the request. + + + + + The diagnostic investigation was attempted, but due to some procedural error, it could not be completed. + + + + + + + The status of a diagnostic order + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The order has a normal priority. + + + + + The order should be urgently. + + + + + The order is time-critical. + + + + + The order should be acted on as soon as possible. + + + + + + + The clinical priority of a diagnostic order + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports. + + + + + The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + A code or name that describes this diagnostic report. + + + + + The status of the diagnostic report as a whole. + + + + + The date and/or time that this version of the report was released from the source diagnostic service. + + + + + The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources. + + + + + The diagnostic service that is responsible for issuing the report. + + + + + The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider. + + + + + Details concerning a test requested. + + + + + The section of the diagnostic service that performs the examination e.g. biochemistry, hematology, MRI. + + + + + The time or time-period the observed values are related to. This is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. + + + + + + + Details about the specimens on which this Disagnostic report is based. + + + + + Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels"). + + + + + One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. + + + + + A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). + + + + + Concise and clinically contextualized narrative interpretation of the diagnostic report. + + + + + Codes for the conclusion. + + + + + Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. + + + + + + + + + The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports. + + + + + + + A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. + + + + + Reference to the image source. + + + + + + + + + + + The existence of the report is registered, but there is nothing yet available. + + + + + This is a partial (e.g. initial, interim or preliminary) report: data in the report may be incomplete or unverified. + + + + + The report is complete and verified by an authorized person. + + + + + The report has been modified subsequent to being Final, and is complete and verified by an authorized person. + + + + + The report has been modified subsequent to being Final, and is complete and verified by an authorized person, and data has been changed. + + + + + The report has been modified subsequent to being Final, and is complete and verified by an authorized person. New content has been added, but existing content hasn't changed. + + + + + The report is unavailable because the measurement was not started or not completed (also sometimes called "aborted"). + + + + + The report has been withdrawn following previous Final release. + + + + + + + The status of the diagnostic report as a whole + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A manifest that defines a set of documents. + + + + + A manifest that defines a set of documents. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts. + + + + + Other identifiers associated with the document, including version independent, source record and workflow related identifiers. + + + + + Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case). + + + + + A patient, practitioner, or organization for which this set of documents is intended. + + + + + Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider. + + + + + Identifies who is responsible for adding the information to the document. + + + + + When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated etc). + + + + + Identifies the source system, application, or software that produced the document manifest. + + + + + The status of this document manifest. + + + + + Whether this document manifest replaces another. + + + + + Human-readable description of the source document. This is sometimes known as the "title". + + + + + A code specifying the level of confidentiality of this set of Documents. + + + + + The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed. + + + + + + + + + A reference to a document. + + + + + A reference to a document. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document. + + + + + Other identifiers associated with the document, including version independent, source record and workflow related identifiers. + + + + + Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). + + + + + Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.). + + + + + A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type. + + + + + Identifies who is responsible for adding the information to the document. + + + + + Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. + + + + + A reference to a domain or server that manages policies under which the document is accessed and/or made available. + + + + + Which person or organization authenticates that this document is valid. + + + + + When the document was created. + + + + + When the document reference was created. + + + + + The status of this document reference. + + + + + The status of the underlying document. + + + + + Relationships that this document has with other document references that already exist. + + + + + Human-readable description of the source document. This is sometimes known as the "title". + + + + + A code specifying the level of confidentiality of the XDS Document. + + + + + The primary language in which the source document is written. + + + + + The mime type of the source document. + + + + + An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType. + + + + + The size of the source document this reference refers to in bytes. + + + + + A hash of the source document to ensure that changes have not occurred. + + + + + A url at which the document can be accessed. + + + + + A description of a service call that can be used to retrieve the document. + + + + + The clinical context in which the document was prepared. + + + + + + + + + A reference to a document. + + + + + + + The type of relationship that this document has with anther document. + + + + + The target document of this relationship. + + + + + + + + + A reference to a document. + + + + + + + The type of the service that can be used to access the documents. + + + + + Where the service end-point is located. + + + + + A list of named parameters that is used in the service call. + + + + + + + + + A reference to a document. + + + + + + + The name of a parameter. + + + + + The value of the named parameter. + + + + + + + + + A reference to a document. + + + + + + + This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. + + + + + The time period over which the service that is described by the document was provided. + + + + + The kind of facility where the patient was seen. + + + + + + + + + + + This document logically replaces or supercedes the target document. + + + + + This document was generated by transforming the target document (e.g. format or language conversion). + + + + + This document is a signature of the target document. + + + + + This document adds additional information to the target document. + + + + + + + The type of relationship between documents + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. + + + + + An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Identifier(s) by which this encounter is known. + + + + + planned | in progress | onleave | finished | cancelled. + + + + + inpatient | outpatient | ambulatory | emergency +. + + + + + Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). + + + + + The patient present at the encounter. + + + + + The main practitioner responsible for providing the service. + + + + + The start and end time of the encounter. + + + + + Quantity of time the encounter lasted. This excludes the time during leaves of absence. + + + + + Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. + + + + + Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. + + + + + Indicates the urgency of the encounter. + + + + + Details about an admission to a clinic. + + + + + List of locations at which the patient has been. + + + + + Department or team providing care. + + + + + Another Encounter of which this encounter is a part of (administratively or in time). + + + + + + + + + An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. + + + + + + + Role of participant in encounter. + + + + + Persons involved in the encounter other than the patient. + + + + + + + + + An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. + + + + + + + Pre-admission identifier. + + + + + The location from which the patient came before admission. + + + + + From where patient was admitted (physician referral, transfer). + + + + + Period during which the patient was admitted. + + + + + Where the patient stays during this encounter. + + + + + Dietary restrictions for the patient. + + + + + Special courtesies (VIP, board member). + + + + + Wheelchair, translator, stretcher, etc. + + + + + Location to which the patient is discharged. + + + + + Category or kind of location after discharge. + + + + + The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete. + + + + + Whether this hospitalization is a readmission. + + + + + + + + + An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. + + + + + + + The bed that is assigned to the patient. + + + + + Period during which the patient was assigned the bed. + + + + + + + + + An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. + + + + + + + The location where the encounter takes place. + + + + + Time period during which the patient was present at the location. + + + + + + + + + + + An encounter during which the patient is hospitalized and stays overnight. + + + + + An encounter during which the patient is not hospitalized overnight. + + + + + An encounter where the patient visits the practitioner in his/her office, e.g. a G.P. visit. + + + + + An encounter where the patient needs urgent care. + + + + + An encounter where the practitioner visits the patient at his/her home. + + + + + An encounter taking place outside the regular environment for giving care. + + + + + An encounter where the patient needs more prolonged treatment or investigations than outpatients, but who do not need to stay in the hospital overnight. + + + + + An encounter that takes place where the patient and practitioner do not physically meet but use electronic means for contact. + + + + + + + Classification of the encounter + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The Encounter has not yet started. + + + + + The Encounter has begun and the patient is present / the practitioner and the patient are meeting. + + + + + The Encounter has begun, but the patient is temporarily on leave. + + + + + The Encounter has ended. + + + + + The Encounter has ended before it has begun. + + + + + + + Current state of the encounter + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Significant health events and conditions for people related to the subject relevant in the context of care for the subject. + + + + + Significant health events and conditions for people related to the subject relevant in the context of care for the subject. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + This records identifiers associated with this family history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). + + + + + The person who this history concerns. + + + + + Conveys information about family history not specific to individual relations. + + + + + The related person. Each FamilyHistory resource contains the entire family history for a single person. + + + + + + + + + Significant health events and conditions for people related to the subject relevant in the context of care for the subject. + + + + + + + This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair". + + + + + The type of relationship this person has to the patient (father, mother, brother etc.). + + + + + The actual or approximate date of birth of the relative. + + + + + + + + If this resource is indicating that the related person is deceased, then an indicator of whether the person is deceased (yes) or not (no) or the age or age range or description of age at death - can be indicated here. If the reason for death is known, then it can be indicated in the outcome code of the condition - in this case the deceased property should still be set. + + + + + + + + + + This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible. + + + + + The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition. + + + + + + + + + Significant health events and conditions for people related to the subject relevant in the context of care for the subject. + + + + + + + The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system. + + + + + Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation. + + + + + Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence. + + + + + + + + An area where general notes can be placed about this specific condition. + + + + + + + + + Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization. + + + + + Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + A unique business identifier for this group. + + + + + Identifies the broad classification of the kind of resources the group includes. + + + + + If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals. + + + + + Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc. + + + + + A label assigned to the group for human identification and communication. + + + + + A count of the number of resource instances that are part of the group. + + + + + Identifies the traits shared by members of the group. + + + + + Identifies the resource instances that are members of the group. + + + + + + + + + Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization. + + + + + + + A code that identifies the kind of trait being asserted. + + + + + The value of the trait that holds (or does not hold - see 'exclude') for members of the group. + + + + + + + + + If true, indicates the characteristic is one that is NOT held by members of the group. + + + + + + + + + + + Group contains "person" Patient resources. + + + + + Group contains "animal" Patient resources. + + + + + Group contains healthcare practitioner resources. + + + + + Group contains Device resources. + + + + + Group contains Medication resources. + + + + + Group contains Substance resources. + + + + + + + Types of resources that are part of group + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images. + + + + + Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Date and Time the study took place. + + + + + Who the images are of. + + + + + Formal identifier for the study. + + + + + Accession Number. + + + + + Other identifiers for the study. + + + + + A list of the diagnostic orders that resulted in this imaging study being performed. + + + + + A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). + + + + + The requesting/referring physician. + + + + + Availability of study (online, offline or nearline). + + + + + WADO-RS URI where Study is available. + + + + + Number of Series in Study. + + + + + Number of SOP Instances in Study. + + + + + Diagnoses etc provided with request. + + + + + Type of procedure performed. + + + + + Who read study and interpreted the images. + + + + + Institution-generated description or classification of the Study (component) performed. + + + + + Each study has one or more series of image instances. + + + + + + + + + Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images. + + + + + + + The number of this series in the overall sequence. + + + + + The modality of this series sequence. + + + + + Formal identifier for this series. + + + + + A description of the series. + + + + + Sequence that contains attributes from the. + + + + + Availability of series (online, offline or nearline). + + + + + WADO-RS URI where Series is available. + + + + + Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed. + + + + + When the series started. + + + + + A single image taken from a patient. + + + + + + + + + Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images. + + + + + + + The number of this image in the series. + + + + + Formal identifier for this image. + + + + + DICOM Image type. + + + + + Type of instance (image etc) (0004,1430). + + + + + Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008). + + + + + WADO-RS url where image is available. + + + + + A FHIR resource with content for this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Type of acquired image data in the instance + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Resources are immediately available,. + + + + + Resources need to be retrieved by manual intervention. + + + + + Resources need to be retrieved from relatively slow media. + + + + + Resources cannot be retrieved. + + + + + + + Availability of the resource + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Type of data in the instance + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Immunization event information. + + + + + Immunization event information. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + A unique identifier assigned to this adverse reaction record. + + + + + Date vaccine administered or was to be administered. + + + + + Vaccine that was administered or was to be administered. + + + + + The patient to whom the vaccine was to be administered. + + + + + Indicates if the vaccination was refused. + + + + + True if this administration was reported rather than directly administered. + + + + + Clinician who administered the vaccine. + + + + + Clinician who ordered the vaccination. + + + + + Name of vaccine manufacturer. + + + + + The service delivery location where the vaccine administration occurred. + + + + + Lot number of the vaccine product. + + + + + Date vaccine batch expires. + + + + + Body site where vaccine was administered. + + + + + The path by which the vaccine product is taken into the body. + + + + + The quantity of vaccine product that was administered. + + + + + Reasons why a vaccine was administered or refused. + + + + + Categorical data indicating that an adverse event is associated in time to an immunization. + + + + + Contains information about the protocol(s) under which the vaccine was administered. + + + + + + + + + Immunization event information. + + + + + + + Reasons why a vaccine was administered. + + + + + Refusal or exemption reasons. + + + + + + + + + Immunization event information. + + + + + + + Date of reaction to the immunization. + + + + + Details of the reaction. + + + + + Self-reported indicator. + + + + + + + + + Immunization event information. + + + + + + + Nominal position in a series. + + + + + Contains the description about the protocol under which the vaccine was administered. + + + + + Indicates the authority who published the protocol? E.g. ACIP. + + + + + One possible path to achieve presumed immunity against a disease - within the context of an authority. + + + + + The recommended number of doses to achieve immunity. + + + + + The targeted disease. + + + + + Indicates if the immunization event should "count" against the protocol. + + + + + Provides an explanation as to why a immunization event should or should not count against the protocol. + + + + + + + + + A patient's point-of-time immunization status and recommendation with optional supporting justification. + + + + + A patient's point-of-time immunization status and recommendation with optional supporting justification. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + A unique identifier assigned to this particular recommendation record. + + + + + The patient who is the subject of the profile. + + + + + Vaccine administration recommendations. + + + + + + + + + A patient's point-of-time immunization status and recommendation with optional supporting justification. + + + + + + + The date the immunization recommendation was created. + + + + + Vaccine that pertains to the recommendation. + + + + + This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose). + + + + + Vaccine administration status. + + + + + Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc. + + + + + Contains information about the protocol under which the vaccine was administered. + + + + + Immunization event history that supports the status and recommendation. + + + + + Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. + + + + + + + + + A patient's point-of-time immunization status and recommendation with optional supporting justification. + + + + + + + Date classification of recommendation - e.g. earliest date to give, latest date to give, etc. + + + + + Date recommendation. + + + + + + + + + A patient's point-of-time immunization status and recommendation with optional supporting justification. + + + + + + + Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol. + + + + + Contains the description about the protocol under which the vaccine was administered. + + + + + Indicates the authority who published the protocol? E.g. ACIP. + + + + + One possible path to achieve presumed immunity against a disease - within the context of an authority. + + + + + + + + + A set of information summarized from a list of other resources. + + + + + A set of information summarized from a list of other resources. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Identifier for the List assigned for business purposes outside the context of FHIR. + + + + + This code defines the purpose of the list - why it was created. + + + + + The common subject (or patient) of the resources that are in the list, if there is one. + + + + + The entity responsible for deciding what the contents of the list were. + + + + + The date that the list was prepared. + + + + + Whether items in the list have a meaningful order. + + + + + How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. + + + + + Entries in this list. + + + + + If the list is empty, why the list is empty. + + + + + + + + + A set of information summarized from a list of other resources. + + + + + + + The flag allows the system constructing the list to make one or more statements about the role and significance of the item in the list. + + + + + True if this item is marked as deleted in the list. + + + + + When this item was added to the list. + + + + + A reference to the actual resource from which data was derived. + + + + + + + + + + + This list is the master list, maintained in an ongoing fashion with regular updates as the real world list it is tracking changes. + + + + + This list was prepared as a snapshot. It should not be assumed to be current. + + + + + The list is prepared as a statement of changes that have been made or recommended. + + + + + + + The processing mode that applies to this list + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated. + + + + + Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Unique code or number identifying the location to its users. + + + + + Name of the location as used by humans. Does not need to be unique. + + + + + Description of the Location, which helps in finding or referencing the place. + + + + + Indicates the type of function performed at the location. + + + + + The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. + + + + + Physical location. + + + + + Physical form of the location, e.g. building, room, vehicle, road. + + + + + The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML). + + + + + The organization that is responsible for the provisioning and upkeep of the location. + + + + + active | suspended | inactive. + + + + + Another Location which this Location is physically part of. + + + + + Indicates whether a resource instance represents a specific location or a class of locations. + + + + + + + + + Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated. + + + + + + + Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). + + + + + Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). + + + + + Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). + + + + + + + + + + + The location is operational. + + + + + The location is temporarily closed. + + + + + The location is no longer used. + + + + + + + Indicates whether the location is still in use + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The Location resource represents a specific instance of a Location. + + + + + The Location represents a class of Locations. + + + + + + + Indicates whether a resource instance represents a specific location or a class of locations + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. + + + + + A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Whether the media is a photo (still image), an audio recording, or a video recording. + + + + + Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality. + + + + + Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. + + + + + When the media was originally recorded. For video and audio, if the length of the recording is not insignificant, this is the end of the recording. + + + + + Who/What this Media is a record of. + + + + + The person who administered the collection of the image. + + + + + The name of the imaging view e.g Lateral or Antero-posterior (AP). + + + + + The name of the device / manufacturer of the device that was used to make the recording. + + + + + Height of the image in pixels(photo/video). + + + + + Width of the image in pixels (photo/video). + + + + + The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. + + + + + The length of the recording in seconds - for audio and video. + + + + + The actual content of the media - inline or by direct reference to the media source file. + + + + + + + + + + + The media consists of one or more unmoving images, including photographs, computer-generated graphs and charts, and scanned documents. + + + + + The media consists of a series of frames that capture a moving image. + + + + + The media consists of a sound recording. + + + + + + + Whether the Media is a photo, video, or audio + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Primarily used for identification and definition of Medication, but also covers ingredients and packaging. + + + + + Primarily used for identification and definition of Medication, but also covers ingredients and packaging. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code. + + + + + A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes. + + + + + Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is). + + + + + Describes the details of the manufacturer. + + + + + Medications are either a single administrable product or a package that contains one or more products. + + + + + Information that only applies to products (not packages). + + + + + Information that only applies to packages (not products). + + + + + + + + + Primarily used for identification and definition of Medication, but also covers ingredients and packaging. + + + + + + + Describes the form of the item. Powder; tables; carton. + + + + + Identifies a particular constituent of interest in the product. + + + + + + + + + Primarily used for identification and definition of Medication, but also covers ingredients and packaging. + + + + + + + The actual ingredient - either a substance (simple ingredient) or another medication. + + + + + Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet. + + + + + + + + + Primarily used for identification and definition of Medication, but also covers ingredients and packaging. + + + + + + + The kind of container that this package comes as. + + + + + A set of components that go to make up the described item. + + + + + + + + + Primarily used for identification and definition of Medication, but also covers ingredients and packaging. + + + + + + + Identifies one of the items in the package. + + + + + The amount of the product that is in the package. + + + + + + + + + + + The medication is a product. + + + + + The medication is a package - a contained group of one of more products. + + + + + + + Whether the medication is a product or a package + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. + +Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. + + + + + Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. + +Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated. + + + + + Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way. + + + + + The person or animal to whom the medication was given. + + + + + The individual who was responsible for giving the medication to the patient. + + + + + The visit or admission the or other contact between patient and health care provider the medication administration was performed as part of. + + + + + The original request, instruction or authority to perform the administration. + + + + + Set this to true if the record is saying that the medication was NOT administered. + + + + + A code indicating why the administration was not performed. + + + + + An interval of time during which the administration took place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same. + + + + + Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. + + + + + The device used in administering the medication to the patient. E.g. a particular infusion pump. + + + + + Provides details of how much of the medication was administered. + + + + + + + + + Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. + +Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. + + + + + + + The timing schedule for giving the medication to the patient. This may be a single time point (using dateTime) or it may be a start and end dateTime (Period). + + + + + + + If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication. + + + + + + + A coded specification of the anatomic site where the medication first entered the body. E.g. "left arm". + + + + + A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. E.g. topical, intravenous, etc. + + + + + A coded value indicating the method by which the medication was introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV. + +Terminologies used often pre-coordinate this term with the route and or form of administration. + + + + + The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection. + + + + + Identifies the speed with which the medication was introduced into the patient. Typically the rate for an infusion e.g. 200ml in 2 hours. May also expressed as a rate per unit of time such as 100ml per hour - the duration is then not specified, or is specified in the quantity. + + + + + The maximum total quantity of a therapeutic substance that was administered to the patient over the specified period of time. E.g. 1000mg in 24 hours. + + + + + + + + + + + The administration has started but has not yet completed. + + + + + Actions implied by the administration have been temporarily halted, but are expected to continue later. May also be called "suspended". + + + + + All actions that are implied by the administration have occurred. + + + + + The administration was entered in error and therefore nullified. + + + + + Actions implied by the administration have been permanently halted, before all of them occurred. + + + + + + + A set of codes indicating the current status of a MedicationAdministration + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication. + + + + + Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR. + + + + + A code specifying the state of the set of dispense events. + + + + + A link to a resource representing the person to whom the medication will be given. + + + + + The individual responsible for dispensing the medication. + + + + + Indicates the medication order that is being dispensed against. + + + + + Indicates the details of the dispense event such as the days supply and quantity of medication dispensed. + + + + + Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but doesn't happen, in other cases substitution is not expected but does happen. This block explains what substitition did or did not happen and why. + + + + + + + + + Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication. + + + + + + + Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR. + + + + + A code specifying the state of the dispense event. + + + + + Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. + + + + + The amount of medication that has been dispensed. Includes unit of measure. + + + + + Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. + + + + + The time when the dispensed product was packaged and reviewed. + + + + + The time the dispensed product was provided to the patient or their representative. + + + + + Identification of the facility/location where the medication was shipped to, as part of the dispense event. + + + + + Identifies the person who picked up the medication. This will usually be a patient or their carer, but some cases exist where it can be a healthcare professional. + + + + + Indicates how the medication is to be used by the patient. + + + + + + + + + Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication. + + + + + + + Additional instructions such as "Swallow with plenty of water" which may or may not be coded. + + + + + The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". + + + + + + + + If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication. + + + + + + + A coded specification of the anatomic site where the medication first enters the body. + + + + + A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject. + + + + + A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV. + +Terminologies used often pre-coordinate this term with the route and or form of administration. + + + + + The amount of therapeutic or other substance given at one administration event. + + + + + Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours. + + + + + The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours. + + + + + + + + + Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication. + + + + + + + A code signifying whether a different drug was dispensed from what was prescribed. + + + + + Indicates the reason for the substitution of (or lack of substitution) from what was prescribed. + + + + + The person or organization that has primary responsibility for the substitution. + + + + + + + + + + + The dispense has started but has not yet completed. + + + + + Actions implied by the administration have been temporarily halted, but are expected to continue later. May also be called "suspended". + + + + + All actions that are implied by the dispense have occurred. + + + + + The dispense was entered in error and therefore nullified. + + + + + Actions implied by the dispense have been permanently halted, before all of them occurred. + + + + + + + A code specifying the state of the dispense event. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + An order for both supply of the medication and the instructions for administration of the medicine to a patient. + + + + + An order for both supply of the medication and the instructions for administration of the medicine to a patient. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system. + + + + + The date (and perhaps time) when the prescription was written. + + + + + A code specifying the state of the order. Generally this will be active or completed state. + + + + + A link to a resource representing the person to whom the medication will be given. + + + + + The healthcare professional responsible for authorizing the prescription. + + + + + A link to a resource that identifies the particular occurrence of contact between patient and health care provider. + + + + + Can be the reason or the indication for writing the prescription. + + + + + + + Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. + + + + + Indicates how the medication is to be used by the patient. + + + + + Deals with details of the dispense part of the order. + + + + + Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done. + + + + + + + + + An order for both supply of the medication and the instructions for administration of the medicine to a patient. + + + + + + + Free text dosage instructions for cases where the instructions are too complex to code. + + + + + Additional instructions such as "Swallow with plenty of water" which may or may not be coded. + + + + + The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". + + + + + + + + If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication. + + + + + + + A coded specification of the anatomic site where the medication first enters the body. + + + + + A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient. + + + + + A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV. + +Terminologies used often pre-coordinate this term with the route and or form of administration. + + + + + The amount of therapeutic or other substance given at one administration event. + + + + + Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours. + + + + + The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours. + + + + + + + + + An order for both supply of the medication and the instructions for administration of the medicine to a patient. + + + + + + + Identifies the medication that is to be dispensed. This may be a more specifically defined than the medicationPrescription.medication . This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. + + + + + Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) +It reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. +Rationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription. + + + + + An integer indicating the number of repeats of the Dispense. +UsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill. + + + + + The amount that is to be dispensed. + + + + + Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. +In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors. + + + + + + + + + An order for both supply of the medication and the instructions for administration of the medicine to a patient. + + + + + + + A code signifying whether a different drug should be dispensed from what was prescribed. + + + + + Indicates the reason for the substitution, or why substitution must or must not be performed. + + + + + + + + + + + The prescription is 'actionable', but not all actions that are implied by it have occurred yet. + + + + + Actions implied by the prescription have been temporarily halted, but are expected to continue later. May also be called "suspended". + + + + + All actions that are implied by the prescription have occurred (this will rarely be made explicit). + + + + + The prescription was entered in error and therefore nullified. + + + + + Actions implied by the prescription have been permanently halted, before all of them occurred. + + + + + The prescription was replaced by a newer one, which encompasses all the information in the previous one. + + + + + + + A code specifying the state of the prescribing event. Describes the lifecycle of the prescription. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician. + + + + + A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated. + + + + + The person or animal who is /was taking the medication. + + + + + Set this to true if the record is saying that the medication was NOT taken. + + + + + A code indicating why the medication was not taken. + + + + + The interval of time during which it is being asserted that the patient was taking the medication. + + + + + Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. + + + + + An identifier or a link to a resource that identifies a device used in administering the medication to the patient. + + + + + Indicates how the medication is/was used by the patient. + + + + + + + + + A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician. + + + + + + + The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". + + + + + If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication. + + + + + + + A coded specification of the anatomic site where the medication first enters the body. + + + + + A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject. + + + + + A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV. + +Terminologies used often pre-coordinate this term with the route and or form of administration. + + + + + The amount of therapeutic or other substance given at one administration event. + + + + + Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours. + + + + + The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours. + + + + + + + + + The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. + + + + + The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + The identifier of this message. + + + + + The time that the message was sent. + + + + + Code that identifies the event this message represents and connects it with it's definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/message-type". + + + + + Information about the message that this message is a response to. Only present if this message is a response. + + + + + The source application from which this message originated. + + + + + The destination application which the message is intended for. + + + + + The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. + + + + + The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. + + + + + Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. + + + + + The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. + + + + + Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message. + + + + + The actual data of the message - a reference to the root/focus class of the event. + + + + + + + + + The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. + + + + + + + The id of the message that this message is a response to. + + + + + Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. + + + + + Full details of any issues found in the message. + + + + + + + + + The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. + + + + + + + Human-readable name for the target system. + + + + + May include configuration or other information useful in debugging. + + + + + Can convey versions of multiple systems in situations where a message passes through multiple hands. + + + + + An e-mail, phone, website or other contact point to use to resolve issues with message communications. + + + + + Identifies the routing target to send acknowledgements to. + + + + + + + + + The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. + + + + + + + Human-readable name for the source system. + + + + + Identifies the target end system in situations where the initial message transmission is to an intermediary system. + + + + + Indicates where the message should be routed to. + + + + + + + + + + + The message was accepted and processed without error. + + + + + Some internal unexpected error occurred - wait and try again. Note - this is usually used for things like database unavailable, which may be expected to resolve, though human intervention may be required. + + + + + The message was rejected because of some content in it. There is no point in re-sending without change. The response narrative SHALL describe what the issue is. + + + + + + + The kind of response to a message + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Measurements and simple assertions made about a patient, device or other subject. + + + + + Measurements and simple assertions made about a patient, device or other subject. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Describes what was observed. Sometimes this is called the observation "code". + + + + + The information determined as a result of making the observation, if the information has a simple value. + + + + + + + + + + + + The assessment made based on the result of the observation. + + + + + May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result. + + + + + The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. + + + + + + + Date/Time this was made available. + + + + + The status of the result value. + + + + + An estimate of the degree to which quality issues have impacted on the value reported. + + + + + Indicates where on the subject's body the observation was made. + + + + + Indicates the mechanism used to perform the observation. + + + + + A unique identifier for the simple observation. + + + + + The thing the observation is being made about. + + + + + The specimen that was used when this observation was made. + + + + + Who was responsible for asserting the observed value as "true". + + + + + Guidance on how to interpret the value by comparison to a normal or recommended range. + + + + + Related observations - either components, or previous observations, or statements of derivation. + + + + + + + + + Measurements and simple assertions made about a patient, device or other subject. + + + + + + + The value of the low bound of the reference range. If this is omitted, the low bound of the reference range is assumed to be meaningless. E.g. <2.3. + + + + + The value of the high bound of the reference range. If this is omitted, the high bound of the reference range is assumed to be meaningless. E.g. >5. + + + + + Code for the meaning of the reference range. + + + + + The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. + + + + + + + + + Measurements and simple assertions made about a patient, device or other subject. + + + + + + + A code specifying the kind of relationship that exists with the target observation. + + + + + A reference to the observation that is related to this observation. + + + + + + + + + + + The result has no reliability concerns. + + + + + An early estimate of value; measurement is still occurring. + + + + + An early estimate of value; processing is still occurring. + + + + + The observation value should be treated with care. + + + + + The result has been generated while calibration is occurring. + + + + + The observation could not be completed because of an error. + + + + + No observation value was available. + + + + + + + Codes that provide an estimate of the degree to which quality issues have impacted on the value of an observation + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The existence of the observation is registered, but there is no result yet available. + + + + + This is an initial or interim observation: data may be incomplete or unverified. + + + + + The observation is complete and verified by an authorized person. + + + + + The observation has been modified subsequent to being Final, and is complete and verified by an authorized person. + + + + + The observation is unavailable because the measurement was not started or not completed (also sometimes called "aborted"). + + + + + The observation has been withdrawn following previous Final release. + + + + + + + Codes providing the status of an observation + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The target observation is a component of this observation (e.g. Systolic and Diastolic Blood Pressure). + + + + + This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. + + + + + The target observation is part of the information from which this observation value is derived (e.g. calculated anion gap, Apgar score). + + + + + This observation follows the target observation (e.g. timed tests such as Glucose Tolerance Test). + + + + + This observation replaces a previous observation (i.e. a revised value). The target observation is now obsolete. + + + + + The value of the target observation qualifies (refines) the semantics of the source observation (e.g. a lipaemia measure target from a plasma measure). + + + + + The value of the target observation interferes (degardes quality, or prevents valid observation) with the semantics of the source observation (e.g. a hemolysis measure target from a plasma potassium measure which has no value). + + + + + + + Codes specifying how two observations are related + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A collection of error, warning or information messages that result from a system action. + + + + + A collection of error, warning or information messages that result from a system action. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + An error, warning or information message that results from a system action. + + + + + + + + + A collection of error, warning or information messages that result from a system action. + + + + + + + Indicates whether the issue indicates a variation from successful processing. + + + + + A code indicating the type of error, warning or information message. + + + + + Additional description of the issue. + + + + + A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised. + + + + + + + + + + + The issue caused the action to fail, and no further checking could be performed. + + + + + The issue is sufficiently important to cause the action to fail. + + + + + The issue is not important enough to cause the action to fail, but may cause it to be performed suboptimally or in a way that is not as desired. + + + + + The issue has no relation to the degree of success of the action. + + + + + + + How the issue affects the success of the action + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A request to perform an action. + + + + + A request to perform an action. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Identifiers assigned to this order by the orderer or by the receiver. + + + + + When the order was made. + + + + + Patient this order is about. + + + + + Who initiated the order. + + + + + Who is intended to fulfill the order. + + + + + Text - why the order was made. + + + + + + + If required by policy. + + + + + When order should be fulfilled. + + + + + What action is being ordered. + + + + + + + + + A request to perform an action. + + + + + + + Code specifies when request should be done. The code may simply be a priority code. + + + + + A formal schedule. + + + + + + + + + A response to an order. + + + + + A response to an order. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems. + + + + + A reference to the order that this is in response to. + + + + + The date and time at which this order response was made (created/posted). + + + + + The person, organization, or device credited with making the response. + + + + + A reference to an authority policy that is the reason for the response. Usually this is used when the order is rejected, to provide a reason for rejection. + + + + + + + What this response says about the status of the original order. + + + + + Additional description about the response - e.g. a text description provided by a human user when making decisions about the order. + + + + + Links to resources that provide details of the outcome of performing the order. E.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order. + + + + + + + + + + + The order is known, but no processing has occurred at this time. + + + + + The order is undergoing initial processing to determine whether it will be accepted (usually this involves human review). + + + + + The order was rejected because of a workflow/business logic reason. + + + + + The order was unable to be processed because of a technical error (i.e. unexpected error). + + + + + The order has been accepted, and work is in progress. + + + + + Processing the order was halted at the initiators request. + + + + + The order has been cancelled and replaced by another. + + + + + Processing the order was stopped because of some workflow/business logic reason. + + + + + The order has been completed. + + + + + + + The status of the response to an order + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc. + + + + + A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Identifier for the organization that is used to identify the organization across multiple disparate systems. + + + + + A name associated with the organization. + + + + + The kind of organization that this is. + + + + + A contact detail for the organization. + + + + + An address for the organization. + + + + + The organization of which this organization forms a part. + + + + + Contact for the organization for a certain purpose. + + + + + Location(s) the organization uses to provide services. + + + + + Whether the organization's record is still in active use. + + + + + + + + + A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc. + + + + + + + Indicates a purpose for which the contact can be reached. + + + + + A name associated with the contact. + + + + + A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. + + + + + Visiting or postal addresses for the contact. + + + + + Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. + + + + + + + + + Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest. + + + + + Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Identifier assigned to the resource for business purposes, outside the context of FHIR. + + + + + Identifies the 'type' of resource - equivalent to the resource name for other resources. + + + + + Identifies the patient, practitioner, device or any other resource that is the "focus" of this resoruce. + + + + + Indicates who was responsible for creating the resource instance. + + + + + Identifies when the resource was first created. + + + + + + + + + Demographics and other administrative information about a person or animal receiving care or other health-related services. + + + + + Demographics and other administrative information about a person or animal receiving care or other health-related services. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + An identifier that applies to this person as a patient. + + + + + A name associated with the individual. + + + + + A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. + + + + + Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. + + + + + The date and time of birth for the individual. + + + + + Indicates if the individual is deceased or not. + + + + + + + Addresses for the individual. + + + + + This field contains a patient's most recent marital (civil) status. + + + + + Indicates whether the patient is part of a multiple or indicates the actual birth order. + + + + + + + Image of the person. + + + + + A contact party (e.g. guardian, partner, friend) for the patient. + + + + + This element has a value if the patient is an animal. + + + + + Languages which may be used to communicate with the patient about his or her health. + + + + + Patient's nominated care provider. + + + + + Organization that is the custodian of the patient record. + + + + + Link to another patient resource that concerns the same actual person. + + + + + Whether this patient record is in active use. + + + + + + + + + Demographics and other administrative information about a person or animal receiving care or other health-related services. + + + + + + + The nature of the relationship between the patient and the contact person. + + + + + A name associated with the person. + + + + + A contact detail for the person, e.g. a telephone number or an email address. + + + + + Address for the contact person. + + + + + Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. + + + + + Organization on behalf of which the contact is acting or for which the contact is working. + + + + + + + + + Demographics and other administrative information about a person or animal receiving care or other health-related services. + + + + + + + Identifies the high level categorization of the kind of animal. + + + + + Identifies the detailed categorization of the kind of animal. + + + + + Indicates the current state of the animal's reproductive organs. + + + + + + + + + Demographics and other administrative information about a person or animal receiving care or other health-related services. + + + + + + + The other patient resource that the link refers to. + + + + + The type of link between this patient resource and another patient resource. + + + + + + + + + + + The patient resource containing this link must no longer be used. The link points forward to another patient resource that must be used in lieu of the patient resource that contains the link. + + + + + The patient resource containing this link is in use and valid but not considered the main source of information about a patient. The link points forward to another patient resource that should be consulted to retrieve additional patient information. + + + + + The patient resource containing this link is in use and valid, but points to another patient resource that is known to contain data about the same person. Data in this resource might overlap or contradict information found in the other patient resource. This link does not indicate any relative importance of the resources concerned, and both should be regarded as equally valid. + + + + + + + The type of link between this patient resource and another patient resource. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A person who is directly or indirectly involved in the provisioning of healthcare. + + + + + A person who is directly or indirectly involved in the provisioning of healthcare. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + An identifier that applies to this person in this role. + + + + + A name associated with the person. + + + + + A contact detail for the practitioner, e.g. a telephone number or an email address. + + + + + The postal address where the practitioner can be found or visited or to which mail can be delivered. + + + + + Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. + + + + + The date and time of birth for the practitioner. + + + + + Image of the person. + + + + + The organization that the practitioner represents. + + + + + Roles which this practitioner is authorized to perform for the organization. + + + + + Specific specialty of the practitioner. + + + + + The period during which the person is authorized to act as a practitioner in these role(s) for the organization. + + + + + The location(s) at which this practitioner provides care. + + + + + Qualifications obtained by training and certification. + + + + + A language the practitioner is able to use in patient communication. + + + + + + + + + A person who is directly or indirectly involved in the provisioning of healthcare. + + + + + + + Coded representation of the qualification. + + + + + Period during which the qualification is valid. + + + + + Organization that regulates and issues the qualification. + + + + + + + + + An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy. + + + + + An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + This records identifiers associated with this procedure that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). + + + + + The person on whom the procedure was performed. + + + + + The specific procedure that is performed. Use text if the exact nature of the procedure can't be coded. + + + + + Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion. + + + + + The reason why the procedure was performed. This may be due to a Condition, may be coded entity of some type, or may simply be present as text. + + + + + Limited to 'real' people rather than equipment. + + + + + The dates over which the procedure was performed. Allows a period to support complex procedures that span more that one date, and also allows for the length of the procedure to be captured. + + + + + The encounter during which the procedure was performed. + + + + + What was the outcome of the procedure - did it resolve reasons why the procedure was performed?. + + + + + This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies. + + + + + Any complications that occurred during the procedure, or in the immediate post-operative period. These are generally tracked separately from the notes, which typically will describe the procedure itself rather than any 'post procedure' issues. + + + + + If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or potentially could be more complex in which case the CarePlan resource can be used. + + + + + Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure. + + + + + Any other notes about the procedure - e.g. the operative notes. + + + + + + + + + An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy. + + + + + + + The practitioner who was involved in the procedure. + + + + + E.g. surgeon, anaethetist, endoscopist. + + + + + + + + + An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy. + + + + + + + The nature of the relationship. + + + + + The related item - e.g. a procedure. + + + + + + + + + + + This procedure had to be performed because of the related one. + + + + + This procedure caused the related one to be performed. + + + + + + + The nature of the relationship with this procedure + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + The identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI). + + + + + The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp. + + + + + A free text natural language name identifying the Profile. + + + + + Details of the individual or organization who accepts responsibility for publishing the profile. + + + + + Contact details to assist a user in finding and communicating with the publisher. + + + + + A free text natural language description of the profile and its use. + + + + + A set of terms from external terminologies that may be used to assist with indexing and searching of templates. + + + + + The status of the profile. + + + + + This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. + + + + + The date that this version of the profile was published. + + + + + The Scope and Usage that this profile was created to meet. + + + + + The version of the FHIR specification on which this profile is based. + + + + + An external specification that the content is mapped to. + + + + + A constraint statement about what contents a resource or data type may have. + + + + + An extension defined as part of the profile. + + + + + Definition of a named query and its parameters and their meaning. + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + An Internal id that is used to identify this mapping set when specific mappings are made. + + + + + A URI that identifies the specification that this mapping is expressed to. + + + + + A name for the specification that is being mapped to. + + + + + Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + The Resource or Data type being described. + + + + + The name of this resource constraint statement (to refer to it from other resource constraints - from Profile.structure.element.definition.type.profile). + + + + + This definition of a profile on a structure is published as a formal statement. Some structural definitions might be defined purely for internal use within the profile, and not intended to be used outside that context. + + + + + Human summary: why describe this resource?. + + + + + Captures constraints on each element within the resource. + + + + + Additional search parameters for implementations to support and/or make use of. + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource. + + + + + Codes that define how this element is represented in instances, when the deviation varies from the normal case. + + + + + The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element. + + + + + Indicates that the element is sliced into a set of alternative definitions (there are multiple definitions on a single element in the base resource). The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set). + + + + + Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource. + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + Designates which child element is used to discriminate between the slices when processing an instance. The value of the child element in the instance SHALL completely distinguish which slice the element in the resource matches based on the allowed values for that element in each of the slices. + + + + + If the matching elements have to occur in the same order as defined in the profile. + + + + + Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end. + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + A concise definition that is shown in the generated XML format that summarizes profiles (used throughout the specification). + + + + + The definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource. + + + + + Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etc. + + + + + Explains why this element is needed and why it's been constrained as it has. + + + + + Identifies additional names by which this element might also be known. + + + + + The minimum number of times this element SHALL appear in the instance. + + + + + The maximum number of times this element is permitted to appear in the instance. + + + + + The data type or resource that the value of this element is permitted to be. + + + + + Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element. + + + + + Specifies a primitive value that SHALL hold for this element in the instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An example value for this element. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates the shortest length that SHALL be supported by conformant instances without truncation. + + + + + A reference to an invariant that may make additional statements about the cardinality or value in the instance. + + + + + Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance. + + + + + If true, conformant resource authors SHALL be capable of providing a value for the element and resource consumers SHALL be capable of extracting and doing something useful with the data element. If false, the element may be ignored and not supported. + + + + + If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system. + + + + + Binds to a value set if this element is coded (code, Coding, CodeableConcept). + + + + + Identifies a concept from an external specification that roughly corresponds to this element. + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + Name of Data type or Resource. + + + + + Identifies a profile that SHALL hold for resources or datatypes referenced as the type of this element. Can be a local reference - to another structure in this profile, or a reference to a structure in another profile. + + + + + If the type is a reference to another resource, how the resource is or can be aggreated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle. + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality. + + + + + Used to label the constraint in OCL or in short displays incapable of displaying the full human description. + + + + + Identifies the impact constraint violation has on the conformance of the instance. + + + + + Text that can be used to describe the constraint in messages identifying that the constraint has been violated. + + + + + XPath expression of constraint. + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + A descriptive name for this - can be useful for generating implementation artifacts. + + + + + If true, then conformant systems may use additional codes or (where the data type permits) text alone to convey concepts not covered by the set of codes identified in the binding. If false, then conformant systems are constrained to the provided codes alone. + + + + + Indicates the degree of conformance expectations associated with this binding. + + + + + Describes the intended use of this particular set of codes. + + + + + Points to the value set or external definition that identifies the set of codes to be used. + + + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + An internal reference to the definition of a mapping. + + + + + Expresses what part of the target specification corresponds to this element. + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + The name of the standard or custom search parameter. + + + + + The type of value a search parameter refers to, and how the content is interpreted. + + + + + A specification for search parameters. For standard parameters, provides additional information on how the parameter is used in this solution. For custom parameters, provides a description of what the parameter does. + + + + + An XPath expression that returns a set of elements for the search parameter. + + + + + Types of resource (if a resource is referenced). + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + A unique code (within the profile) used to identify the extension. + + + + + Defined so that applications can use this name when displaying the value of the extension to the user. + + + + + Identifies the type of context to which the extension applies. + + + + + Identifies the types of resource or data type elements to which the extension can be applied. + + + + + Definition of the extension and its content. + + + + + + + + + A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions. + + + + + + + The name of a query, which is used in the URI from Conformance statements declaring use of the query. Typically this will also be the name for the _query parameter when the query is called, though in some cases it may be aliased by a server to avoid collisions. + + + + + Description of the query - the functionality it offers, and considerations about how it functions and to use it. + + + + + A parameter of a named query. + + + + + + + + + + + Only codes in the specified set are allowed. If the binding is extensible, other codes may be used for concepts not covered by the bound set of codes. + + + + + For greater interoperability, implementers are strongly encouraged to use the bound set of codes, however alternate codes may be used in derived profiles and implementations if necessary without being considered non-conformant. + + + + + The codes in the set are an example to illustrate the meaning of the field. There is no particular preference for its use nor any assertion that the provided values are sufficient to meet implementation needs. + + + + + + + Binding conformance for applications + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + If the constraint is violated, the resource is not conformant. + + + + + If the constraint is violated, the resource is conformant, but it is not necessarily following best practice. + + + + + + + SHALL applications comply with this constraint? + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + This profile is still under development. + + + + + This profile is ready for normal use. + + + + + This profile has been deprecated, withdrawn or superseded and should no longer be used. + + + + + + + The lifecycle status of a Resource Profile + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + In XML, this property is represented as an attribute not an element. + + + + + + + How a property is represented on the wire + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The reference is a local reference to a contained resource. + + + + + The reference to to a resource that has to be resolved externally to the resource that includes the reference. + + + + + The resource the reference points to will be found in the same bundle as the resource that includes the reference. + + + + + + + How resource references can be aggregated + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The context is all elements matching a particular resource element path. + + + + + The context is all nodes matching a particular data type element path (root or repeating element) or all elements referencing a particular primitive data type (expressed as the datatype name). + + + + + The context is all nodes whose mapping to a specified reference model corresponds to a particular mapping structure. The context identifies the mapping target. The mapping should clearly identify where such an extension could be used. + + + + + The context is a particular extension from a particular profile. Expressed as uri#name, where uri identifies the profile and #name identifies the extension code. + + + + + + + How an extension context is interpreted + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + No additional content is allowed other than that described by the slices in this profile. + + + + + Additional content is allowed anywhere in the list. + + + + + Additional content is allowed, but only at the end of the list. + + + + + + + How slices are interpreted when evaluating an instance + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance. + + + + + Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + The resource(s) that were generated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity. + + + + + The period during which the activity occurred. + + + + + The instant of time at which the activity was recorded. + + + + + The reason that the activity was taking place. + + + + + Where the activity occurred, if relevant. + + + + + Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. + + + + + An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility. + + + + + An entity used in this activity. + + + + + A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation. + + + + + + + + + Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance. + + + + + + + The role that the participant played. + + + + + The type of the participant. + + + + + Identity of participant. May be a logical or physical uri and maybe absolute or relative. + + + + + Human-readable description of the participant. + + + + + + + + + Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance. + + + + + + + How the entity was used during the activity. + + + + + The type of the entity. If the entity is a resource, then this is a resource type. + + + + + Identity of participant. May be a logical or physical uri and maybe absolute or relative. + + + + + Human-readable description of the entity. + + + + + The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity. + + + + + + + + + + + A transformation of an entity into another, an update of an entity resulting in a new one, or the construction of a new entity based on a preexisting entity. + + + + + A derivation for which the resulting entity is a revised version of some original. + + + + + The repeat of (some or all of) an entity, such as text or image, by someone who may or may not be its original author. + + + + + A primary source for a topic refers to something produced by some agent with direct experience and knowledge about the topic, at the time of the topic's study, without benefit from hindsight. + + + + + + + How an entity was used in an activity + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A description of a query with a set of parameters. + + + + + A description of a query with a set of parameters. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Links query and its response(s). + + + + + Set of query parameters with values. + + + + + If this is a response to a query. + + + + + + + + + A description of a query with a set of parameters. + + + + + + + Links response to source query. + + + + + Outcome of processing the query. + + + + + Total number of matching records. + + + + + Parameters server used. + + + + + To get first page (if paged). + + + + + To get previous page (if paged). + + + + + To get next page (if paged). + + + + + To get last page (if paged). + + + + + Resources that are the results of the search. + + + + + + + + + + + The query was processed successfully. + + + + + The query was processed successfully, but some additional limitations were added. + + + + + The server refused to process the query. + + + + + The server tried to process the query, but some error occurred. + + + + + + + The outcome of processing a query request + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A structured set of questions and their answers. The Questionnaire may contain questions, answers or both. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions. + + + + + A structured set of questions and their answers. The Questionnaire may contain questions, answers or both. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + The lifecycle status of the questionnaire as a whole. + + + + + The date and/or time that this version of the questionnaire was authored. + + + + + The subject of the questionnaires: this is the patient that the answers apply to, but this person is not necessarily the source of information. + + + + + Person who received the answers to the questions in the Questionnaire and recorded them in the system. + + + + + The person who answered the questions about the subject. Only used when this is not the subject him/herself. + + + + + Structured name for a predefined list of questions this questionnaire is responding to. + + + + + This records identifiers associated with this question/answer set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). + + + + + Encounter during which this questionnaire answers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers. + + + + + A group of questions to a possibly similarly grouped set of questions in the questionnaire. + + + + + + + + + A structured set of questions and their answers. The Questionnaire may contain questions, answers or both. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions. + + + + + + + Structured name for a section of a predefined list of questions this questionnaire is responding to. + + + + + Text that is displayed above the contents of the group. + + + + + Additional text for the group, used for display purposes. + + + + + More specific subject this section's answers are about, details the subject given in Questionnaire. + + + + + A sub-group within a group. The ordering of groups within this group is relevant. + + + + + Set of questions within this group. The order of questions within the group is relevant. + + + + + + + + + A structured set of questions and their answers. The Questionnaire may contain questions, answers or both. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions. + + + + + + + Structured name for the question that identifies this question within the Questionnaire or Group. + + + + + Text of the question as it is shown to the user. + + + + + Single-valued answer to the question. + + + + + + + + + + + + Selections made by the user from the list of options. + + + + + Reference to a valueset containing the possible options. + + + + + Structured answer in the form of a FHIR Resource or datatype. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The remark contains information about the answer given. This is additional information about the answer the author wishes to convey, but should not be used to contain information that is part of the answer itself. + + + + + Nested group, containing nested question for this question. The order of groups within the question is relevant. + + + + + + + + + + + This Questionnaire is used as a template but the template is not ready for use or publication. + + + + + This Questionnaire is used as a template, is published and ready for use. + + + + + This Questionnaire is used as a template but should no longer be used for new Questionnaires. + + + + + This Questionnaire has been filled out with answers, but changes or additions are still expected to be made to it. + + + + + This Questionnaire has been filled out with answers, and the current content is regarded as definitive. + + + + + This Questionnaire has been filled out with answers, then marked as complete, yet changes or additions have been made to it afterwards. + + + + + + + Lifecycle status of the questionnaire + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. + + + + + Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Identifier for a person within a particular scope. + + + + + The patient this person is related to. + + + + + The nature of the relationship between a patient and the related person. + + + + + A name associated with the person. + + + + + A contact detail for the person, e.g. a telephone number or an email address. + + + + + Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. + + + + + Address where the related person can be contacted or visited. + + + + + Image of the person. + + + + + + + + + A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. + + + + + A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Identifies the name, action type, time, and disposition of the audited event. + + + + + A person, a hardware device or software process. + + + + + Application systems and processes. + + + + + Specific instances of data or objects that have been accessed. + + + + + + + + + A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. + + + + + + + Identifier for a family of the event. + + + + + Identifier for the category of event. + + + + + Indicator for type of action performed during the event that generated the audit. + + + + + The time when the event occurred on the source. + + + + + Indicates whether the event succeeded or failed. + + + + + A free text description of the outcome of the event. + + + + + + + + + A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. + + + + + + + Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context. + + + + + Direct reference to a resource that identifies the participant. + + + + + Unique identifier for the user actively participating in the event. + + + + + Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g., single sign-on), if available. + + + + + Human-meaningful name for the user. + + + + + Indicator that the user is or is not the requestor, or initiator, for the event being audited. + + + + + Type of media involved. Used when the event is about exporting/importing onto media. + + + + + Logical network location for application activity, if the activity has a network location. + + + + + + + + + A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. + + + + + + + An identifier for the network access point of the user device for the audit event. + + + + + An identifier for the type of network access point that originated the audit event. + + + + + + + + + A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. + + + + + + + Logical source location within the healthcare enterprise network. + + + + + Identifier of the source where the event originated. + + + + + Code specifying the type of source where event originated. + + + + + + + + + A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. + + + + + + + Identifies a specific instance of the participant object. The reference should always be version specific. + + + + + Identifies a specific instance of the participant object. The reference should always be version specific. + + + + + Object type being audited. + + + + + Code representing the functional application role of Participant Object being audited. + + + + + Identifier for the data life-cycle stage for the participant object. + + + + + Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics. + + + + + An instance-specific descriptor of the Participant Object ID audited, such as a person's name. + + + + + Text that describes the object in more detail. + + + + + The actual query for a query-type participant object. + + + + + Additional Information about the Object. + + + + + + + + + A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. + + + + + + + Name of the property. + + + + + Property value. + + + + + + + + + + + This object is the patient that is the subject of care related to this event. It is identifiable by patient ID or equivalent. The patient may be either human or animal. + + + + + This is a location identified as related to the event. This is usually the location where the event took place. Note that for shipping, the usual events are arrival at a location or departure from a location. + + + + + This object is any kind of persistent document created as a result of the event. This could be a paper report, film, electronic report, DICOM Study, etc. Issues related to medical records life cycle management are conveyed elsewhere. + + + + + A logical object related to the event. (Deprecated). + + + + + This is any configurable file used to control creation of documents. Examples include the objects maintained by the HL7 Master File transactions, Value Sets, etc. + + + + + A human participant not otherwise identified by some other category. + + + + + (deprecated). + + + + + Typically a licensed person who is providing or performing care related to the event, generally a physician. The key distinction between doctor and practitioner is with regards to their role, not the licensing. The doctor is the human who actually performed the work. The practitioner is the human or organization that is responsible for the work. + + + + + A person or system that is being notified as part of the event. This is relevant in situations where automated systems provide notifications to other parties when an event took place. + + + + + Insurance company, or any other organization who accepts responsibility for paying for the healthcare event. + + + + + A person or active system object involved in the event with a security role. + + + + + A person or system object involved in the event with the authority to modify security roles of other objects. + + + + + A passive object, such as a role table, that is relevant to the event. + + + + + (deprecated) Relevant to certain RBAC security methodologies. + + + + + Any person or organization responsible for providing care. This encompasses all forms of care, licensed or otherwise, and all sorts of teams and care groups. Note, the distinction between practitioners and the doctor that actually provided the care to the patient. + + + + + The source or destination for data transfer, when it does not match some other role. + + + + + A source or destination for data transfer, that acts as an archive, database, or similar role. + + + + + An object that holds schedule information. This could be an appointment book, availability information, etc. + + + + + An organization or person that is the recipient of services. This could be an organization that is buying services for a patient, or a person that is buying services for an animal. + + + + + An order, task, work item, procedure step, or other description of work to be performed. E.g., a particular instance of an MPPS. + + + + + A list of jobs or a system that provides lists of jobs. E.g., an MWL SCP. + + + + + (Deprecated). + + + + + An object that specifies or controls the routing or delivery of items. For example, a distribution list is the routing criteria for mail. The items delivered may be documents, jobs, or other objects. + + + + + The contents of a query. This is used to capture the contents of any kind of query. For security surveillance purposes knowing the queries being made is very important. + + + + + + + Code representing the functional application role of Participant Object being audited + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Person. + + + + + System Object. + + + + + Organization. + + + + + Other. + + + + + + + Code for the participant object type being audited + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Create a new database object, such as Placing an Order. + + + + + Display or print data, such as a Doctor Census. + + + + + Update data, such as Revise Patient Information. + + + + + Delete items, such as a doctor master file record. + + + + + Perform a system or application function such as log-on, program execution or use of an object's method, or perform a query/search operation. + + + + + + + Indicator for type of action performed during the event that generated the audit. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Origination / Creation. + + + + + Import / Copy from original. + + + + + Amendment. + + + + + Verification. + + + + + Translation. + + + + + Access / Use. + + + + + De-identification. + + + + + Aggregation, summarization, derivation. + + + + + Report. + + + + + Export / Copy to target. + + + + + Disclosure. + + + + + Receipt of disclosure. + + + + + Archiving. + + + + + Logical deletion. + + + + + Permanent erasure / Physical destruction. + + + + + + + Identifier for the data life-cycle stage for the participant object + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Machine Name, including DNS name. + + + + + IP Address. + + + + + Telephone Number. + + + + + Email address. + + + + + URI (User directory, HTTP-PUT, ftp, etc.). + + + + + + + The type of network access point that originated the audit event + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + The operation completed successfully (whether with warnings or not). + + + + + The action was not successful due to some kind of catered for error (often equivalent to an HTTP 400 response). + + + + + The action was not successful due to some kind of unexpected error (often equivalent to an HTTP 500 response). + + + + + An error of such magnitude occurred that the system is not longer available for use (i.e. the system died). + + + + + + + Indicates whether the event succeeded or failed + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + Sample for analysis. + + + + + Sample for analysis. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Id for specimen. + + + + + Kind of material that forms the specimen. + + + + + Parent specimen from which the focal specimen was a component. + + + + + Where the specimen came from. This may be the patient(s) or from the environment or a device. + + + + + The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. + + + + + Time when specimen was received for processing or testing. + + + + + Details concerning the specimen collection. + + + + + Details concerning treatment and processing steps for the specimen. + + + + + The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here. + + + + + + + + + Sample for analysis. + + + + + + + Whether this relationship is to a parent or to a child. + + + + + The specimen resource that is the target of this relationship. + + + + + + + + + Sample for analysis. + + + + + + + Person who collected the specimen. + + + + + To communicate any details or issues encountered during the specimen collection procedure. + + + + + Time when specimen was collected from subject - the physiologically relevant time. + + + + + + + The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. + + + + + A coded value specifying the technique that is used to perform the procedure. + + + + + Anatomical location from which the specimen should be collected (if subject is a patient). This element is not used for environmental specimens. + + + + + + + + + Sample for analysis. + + + + + + + Textual description of procedure. + + + + + A coded value specifying the procedure used to process the specimen. + + + + + Material used in the processing step. + + + + + + + + + Sample for analysis. + + + + + + + Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. + + + + + Textual description of the container. + + + + + The type of container associated with the specimen (e.g. slide, aliquot, etc). + + + + + The capacity (volume or other measure) the container may contain. + + + + + The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. + + + + + Additive associated with the container. + + + + + + + + + + + The target resource is the parent of the focal specimen resource. + + + + + The target resource is the child of the focal specimen resource. + + + + + + + Type indicating if this is a parent or child relationship + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A homogeneous material with a definite composition. + + + + + A homogeneous material with a definite composition. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + A code (or set of codes) that identify this substance. + + + + + A description of the substance - its appearance, handling requirements, and other usage notes. + + + + + Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance. + + + + + A substance can be composed of other substances. + + + + + + + + + A homogeneous material with a definite composition. + + + + + + + Identifier associated with the package/container (usually a label affixed directly). + + + + + When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry. + + + + + The amount of the substance. + + + + + + + + + A homogeneous material with a definite composition. + + + + + + + The amount of the ingredient in the substance - a concentration ratio. + + + + + Another substance that is a component of this substance. + + + + + + + + + A supply - a request for something, and provision of what is supplied. + + + + + A supply - a request for something, and provision of what is supplied. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process. + + + + + Unique identifier for this supply request. + + + + + Status of the supply request. + + + + + The item that is requested to be supplied. + + + + + A link to a resource representing the person whom the ordered item is for. + + + + + Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed. + + + + + + + + + A supply - a request for something, and provision of what is supplied. + + + + + + + Identifier assigned by the dispensing facility when the dispense occurs. + + + + + A code specifying the state of the dispense event. + + + + + Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. + + + + + The amount of supply that has been dispensed. Includes unit of measure. + + + + + Identifies the medication or substance being dispensed. This is either a link to a resource representing the details of the medication or substance or a simple attribute carrying a code that identifies the medication from a known list of medications. + + + + + The individual responsible for dispensing the medication. + + + + + The time the dispense event occurred. + + + + + The time the dispensed item was sent or handed to the patient (or agent). + + + + + Identification of the facility/location where the Supply was shipped to, as part of the dispense event. + + + + + Identifies the person who picked up the Supply. + + + + + + + + + + + Supply has been requested, but not dispensed. + + + + + Supply is part of a pharmacy order and has been dispensed. + + + + + Dispensing was not completed. + + + + + + + Status of the dispense + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + + + Supply has been requested, but not dispensed. + + + + + Supply is part of a pharmacy order and has been dispensed. + + + + + Supply has been received by the requestor. + + + + + The supply will not be completed because the supplier was unable or unwilling to supply the item. + + + + + The orderer of the supply cancelled the request. + + + + + + + Status of the supply + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + + + A value set specifies a set of codes drawn from one or more code systems. + + + + + A value set specifies a set of codes drawn from one or more code systems. + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI). + + + + + The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp. + + + + + A free text natural language name describing the value set. + + + + + The name of the individual or organization that published the value set. + + + + + Contacts of the publisher to assist a user in finding and communicating with the publisher. + + + + + A free text natural language description of the use of the value set - reason for definition, conditions of use, etc. + + + + + A copyright statement relating to the value set and/or its contents. + + + + + The status of the value set. + + + + + This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. + + + + + Whether this is intended to be used with an extensible binding or not. + + + + + The date that the value set status was last changed. + + + + + When value set defines its own codes. + + + + + When value set includes codes from elsewhere. + + + + + When value set is an expansion. + + + + + + + + + A value set specifies a set of codes drawn from one or more code systems. + + + + + + + URI to identify the code system. + + + + + The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked. + + + + + If code comparison is case sensitive when codes within this system are compared to each other. + + + + + Concepts in the code system. + + + + + + + + + A value set specifies a set of codes drawn from one or more code systems. + + + + + + + Code that identifies concept. + + + + + If this code is not for use as a real concept. + + + + + Text to Display to the user. + + + + + The formal definition of the concept. Formal definitions are not required, because of the prevalence of legacy systems without them, but they are highly recommended, as without them there is no formal meaning associated with the concept. + + + + + Child Concepts (is-a / contains). + + + + + + + + + A value set specifies a set of codes drawn from one or more code systems. + + + + + + + Includes the contents of the referenced value set as a part of the contents of this value set. + + + + + Include one or more codes from a code system. + + + + + Exclude one or more codes from the value set. + + + + + + + + + A value set specifies a set of codes drawn from one or more code systems. + + + + + + + The code system from which the selected codes come from. + + + + + The version of the code system that the codes are selected from. + + + + + Specifies a code or concept to be included or excluded. The list of codes is considered ordered, though the order may not have any particular significance. + + + + + Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true. + + + + + + + + + A value set specifies a set of codes drawn from one or more code systems. + + + + + + + A code that identifies a property defined in the code system. + + + + + The kind of operation to perform as a part of the filter criteria. + + + + + The match value may be either a code defined by the system, or a string value which is used a regex match on the literal string of the property value. + + + + + + + + + A value set specifies a set of codes drawn from one or more code systems. + + + + + + + An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so. + + + + + Time valueset expansion happened. + + + + + Codes in the value set. + + + + + + + + + A value set specifies a set of codes drawn from one or more code systems. + + + + + + + System value for the code. + + + + + Code - if blank, this is not a choosable code. + + + + + User display for the concept. + + + + + Codes contained in this concept. + + + + + + + + + + + The property value has the concept specified by the value. + + + + + The property value has a concept that has an is-a relationship with the value. + + + + + The property value has a concept that does not have an is-a relationship with the value. + + + + + The property value representation matches the regex specified in the value. + + + + + The property value is in the set of codes or concepts identified by the value. + + + + + The property value is not in the set of codes or concepts identified by the value. + + + + + + + The kind of operation to perform as a part of a property based filter + If the element is present, it must have either a @value, an @id, or extensions + + + + + + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/group.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/group.sch new file mode 100644 index 00000000000..29ddf110397 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/group.sch @@ -0,0 +1,65 @@ + + + + + + + Group + + Inv-1: Can only have members if group is "actual" + Inv-4: Can't have more members associated with the group than the value specified for "quantity" + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: Quantity values cannot have a comparator when used in a Range + Inv-2: If present, low SHALL have a lower value than high + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: Member resource types SHALL agree with group type + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/imagingstudy.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/imagingstudy.sch new file mode 100644 index 00000000000..d4cea646aff --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/imagingstudy.sch @@ -0,0 +1,48 @@ + + + + + + + ImagingStudy + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/immunization.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/immunization.sch new file mode 100644 index 00000000000..c8b70239952 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/immunization.sch @@ -0,0 +1,111 @@ + + + + + + + Immunization + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/immunizationrecommendation.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/immunizationrecommendation.sch new file mode 100644 index 00000000000..0195b4f64b9 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/immunizationrecommendation.sch @@ -0,0 +1,54 @@ + + + + + + + ImmunizationRecommendation + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/list.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/list.sch new file mode 100644 index 00000000000..1aae20a5031 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/list.sch @@ -0,0 +1,55 @@ + + + + + + + List + + Inv-2: The deleted flag can only be used if the mode of the list is "changes" + Inv-1: A list can only have an emptyReason if it is empty + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/location.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/location.sch new file mode 100644 index 00000000000..368bbecbd27 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/location.sch @@ -0,0 +1,48 @@ + + + + + + + Location + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/media.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/media.sch new file mode 100644 index 00000000000..d6619aa4007 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/media.sch @@ -0,0 +1,45 @@ + + + + + + + Media + + Inv-3: Frames can only be used for a photo + Inv-2: Width can only be used for a photo or video + Inv-1: Height can only be used for a photo or video + Inv-4: Length can only be used for an audio or a video + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medication.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medication.sch new file mode 100644 index 00000000000..0deacca5c9e --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medication.sch @@ -0,0 +1,57 @@ + + + + + + + Medication + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: numerator and denominator SHALL both be present, or both be absent + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationadministration.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationadministration.sch new file mode 100644 index 00000000000..b6598dd52e3 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationadministration.sch @@ -0,0 +1,111 @@ + + + + + + + MedicationAdministration + + Inv-2: Reason not given is only permitted if wasNotGiven is true + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have at least one of dosage.quantity and dosage.rate + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: numerator and denominator SHALL both be present, or both be absent + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: numerator and denominator SHALL both be present, or both be absent + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationdispense.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationdispense.sch new file mode 100644 index 00000000000..7df1f36451b --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationdispense.sch @@ -0,0 +1,157 @@ + + + + + + + MedicationDispense + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: whenHandedOver cannot be before whenPrepared + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: There can only be a repeat element if there is none or one event + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-3: At most, only one of count or end can be present + Inv-2: Either frequency or when SHALL be present, but not both + + + Inv-4: duration SHALL be a positive value + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: numerator and denominator SHALL both be present, or both be absent + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: numerator and denominator SHALL both be present, or both be absent + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationprescription.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationprescription.sch new file mode 100644 index 00000000000..039a158b5f9 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationprescription.sch @@ -0,0 +1,151 @@ + + + + + + + MedicationPrescription + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: There can only be a repeat element if there is none or one event + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-3: At most, only one of count or end can be present + Inv-2: Either frequency or when SHALL be present, but not both + + + Inv-4: duration SHALL be a positive value + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: numerator and denominator SHALL both be present, or both be absent + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: numerator and denominator SHALL both be present, or both be absent + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationstatement.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationstatement.sch new file mode 100644 index 00000000000..719e1f0d5b5 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/medicationstatement.sch @@ -0,0 +1,109 @@ + + + + + + + MedicationStatement + + Inv-1: Reason not given is only permitted if wasNotGiven is true + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: There can only be a repeat element if there is none or one event + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-3: At most, only one of count or end can be present + Inv-2: Either frequency or when SHALL be present, but not both + + + Inv-4: duration SHALL be a positive value + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: numerator and denominator SHALL both be present, or both be absent + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: numerator and denominator SHALL both be present, or both be absent + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/messageheader.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/messageheader.sch new file mode 100644 index 00000000000..c5ed091f271 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/messageheader.sch @@ -0,0 +1,51 @@ + + + + + + + MessageHeader + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/observation.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/observation.sch new file mode 100644 index 00000000000..3f7ca42874a --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/observation.sch @@ -0,0 +1,124 @@ + + + + + + + Observation + + Inv-2: Can only have normal range if value is a quantity + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: numerator and denominator SHALL both be present, or both be absent + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: Must have at least a low or a high (and no comparators) + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: Quantity values cannot have a comparator when used in a Range + Inv-2: If present, low SHALL have a lower value than high + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/opensearch.xsd b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/opensearch.xsd new file mode 100644 index 00000000000..2578731a915 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/opensearch.xsd @@ -0,0 +1,11 @@ + + + + + + Used by a server to inform the client of the total number of search + matches (not including including resources) + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/opensearchscore.xsd b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/opensearchscore.xsd new file mode 100644 index 00000000000..5565a595794 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/opensearchscore.xsd @@ -0,0 +1,22 @@ + + + + + +Contains a string indicating a relative assessment of relevance for a particular search result with respect to the search query. + +Decimal values less than 0 should be considered equal to 0. + +Decimal values greater than 1 should be considered equal to 1. + +Unparseable or empty values can be ignored by the client. + +Restrictions: The value must contain a decimal representation of a real number between 0 and 1, inclusive. +Requirements: This element may appear zero or one time. +The score element is used to indicate a relative assessment of relevance for a particular search result with respect to the search query. + + + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/operationoutcome.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/operationoutcome.sch new file mode 100644 index 00000000000..d953e8f2eff --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/operationoutcome.sch @@ -0,0 +1,15 @@ + + + + + + + OperationOutcome + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/order.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/order.sch new file mode 100644 index 00000000000..eafe6c4db06 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/order.sch @@ -0,0 +1,67 @@ + + + + + + + Order + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: Provide a code or a schedule, but not both + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: There can only be a repeat element if there is none or one event + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-3: At most, only one of count or end can be present + Inv-2: Either frequency or when SHALL be present, but not both + + + Inv-4: duration SHALL be a positive value + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/orderresponse.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/orderresponse.sch new file mode 100644 index 00000000000..6fc88d31846 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/orderresponse.sch @@ -0,0 +1,36 @@ + + + + + + + OrderResponse + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/organization.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/organization.sch new file mode 100644 index 00000000000..b39f094d2bf --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/organization.sch @@ -0,0 +1,78 @@ + + + + + + + Organization + + Inv-1: The organization SHALL at least have a name or an id, and possibly more than one + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: The telecom of an organization can never be of use 'home' + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: An address of an organization can never be of use 'home' + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/other.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/other.sch new file mode 100644 index 00000000000..26c4ca90e30 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/other.sch @@ -0,0 +1,30 @@ + + + + + + + Other + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/patient.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/patient.sch new file mode 100644 index 00000000000..f9fb684a74e --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/patient.sch @@ -0,0 +1,126 @@ + + + + + + + Patient + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL at least contain a contact's details or a reference to an organization + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/practitioner.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/practitioner.sch new file mode 100644 index 00000000000..cf41ff94d90 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/practitioner.sch @@ -0,0 +1,87 @@ + + + + + + + Practitioner + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/procedure.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/procedure.sch new file mode 100644 index 00000000000..a92f03f0a77 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/procedure.sch @@ -0,0 +1,78 @@ + + + + + + + Procedure + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/profile.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/profile.sch new file mode 100644 index 00000000000..d909e5a56af --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/profile.sch @@ -0,0 +1,71 @@ + + + + + + + Profile + + Inv-17: There can't be multiple structures with the same type and name + Inv-15: Where multiple structures exist with the same type, they SHALL have names + Inv-8: SHALL define at least one structure constraint or extension definition + Inv-16: Extension definition codes must be unique + Inv-27: Structure name must be unique + Inv-28: Query name must be unique + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-26: Must have at a name or a uri (or both) + + + Inv-18: Element paths must be unique - or not (LM) + Inv-29: Parameter names must be unique within structure + Inv-12: Only complex types can be constrained, not primitive types such as string etc. + + + Inv-21: An element that's a slicing descriptor must not be preceded by an element that starts with the same path and must be followed by an element with exactly the same path. + Inv-20: An element must either be a definition or a slicing descriptor, never both. + Inv-11: Must have either a slice or a definition, but not both + + + Inv-2: Either a namereference or a fixed value (but not both) is permitted + Inv-10: Value may only be specified if the type consists of a single repetition that has a type corresponding to one of the primitive data types. + Inv-7: Binding can only be present for coded elements + Inv-19: Element names must be unique + Inv-22: If a definition has multiple types with the same code, each must specify a profile + Inv-23: Types must be unique by the combination of code and profile + Inv-24: Constraints must be unique by key + Inv-25: Constraint names must be unique. + + + Inv-6: Max SHALL be a number or "*" + + + Inv-9: Aggregation may only be specified if one of the allowed types for the element is a resource + + + Inv-3: provide either a reference or a description (or both) + Inv-14: Example value sets are always extensible + + + Inv-13: uri SHALL start with http:// or https:// + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-5: Codes SHALL be unique in the context of a profile + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/provenance.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/provenance.sch new file mode 100644 index 00000000000..60bd15ba629 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/provenance.sch @@ -0,0 +1,45 @@ + + + + + + + Provenance + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/query.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/query.sch new file mode 100644 index 00000000000..9e5f9710ec6 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/query.sch @@ -0,0 +1,12 @@ + + + + + + + Query + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/questionnaire.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/questionnaire.sch new file mode 100644 index 00000000000..592a52cc1fa --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/questionnaire.sch @@ -0,0 +1,73 @@ + + + + + + + Questionnaire + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: Groups may either contain questions or groups but not both + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Must supply a name, a question's text or both + Inv-1: Must supply either a simple answer, a choice, data or nothing + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/relatedperson.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/relatedperson.sch new file mode 100644 index 00000000000..763f94ec999 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/relatedperson.sch @@ -0,0 +1,48 @@ + + + + + + + RelatedPerson + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/securityevent.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/securityevent.sch new file mode 100644 index 00000000000..fc4582d5fb7 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/securityevent.sch @@ -0,0 +1,76 @@ + + + + + + + SecurityEvent + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: Either a userId or a reference, but not both + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Either an identifier or a reference, but not both + Inv-1: Either a name or a query (or both) + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/specimen.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/specimen.sch new file mode 100644 index 00000000000..2f008b77cc5 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/specimen.sch @@ -0,0 +1,99 @@ + + + + + + + Specimen + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/substance.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/substance.sch new file mode 100644 index 00000000000..9d6fda01a07 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/substance.sch @@ -0,0 +1,39 @@ + + + + + + + Substance + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: numerator and denominator SHALL both be present, or both be absent + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/supply.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/supply.sch new file mode 100644 index 00000000000..e025b1f53db --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/supply.sch @@ -0,0 +1,66 @@ + + + + + + + Supply + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-2: Only one coding in a set can be chosen directly by the user + + + Inv-1: If a valueSet is provided, a system URI Is required + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-3: If a code for the units is present, the system SHALL also be present + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/tombstone.xsd b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/tombstone.xsd new file mode 100644 index 00000000000..8c144525143 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/tombstone.xsd @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/valueset.sch b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/valueset.sch new file mode 100644 index 00000000000..bc37a0eb32a --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/valueset.sch @@ -0,0 +1,36 @@ + + + + + + + ValueSet + + Inv-2: A value set with only one import SHALL also have an include and/or an exclude unless the value set defines its own codes + Inv-7: A defined code system (if present) SHALL have a different identifier to the value set itself + Inv-5: Value set SHALL contain either a define, a compose, or an expansion element + + + Inv-2: A system is required if a value is provided. + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-3: Within a code system definition, all the codes SHALL be unique + Inv-8: Codes must be unique + + + Inv-1: A value set composition SHALL have an include or an import + + + Inv-1: If present, start SHALL have a lower value than end + + + Inv-1: SHALL have a local reference if the resource is provided inline + + + Inv-6: SHALL have a code or a display + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xhtml1-strict.xsd b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xhtml1-strict.xsd new file mode 100644 index 00000000000..3e9de992a03 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xhtml1-strict.xsd @@ -0,0 +1,2044 @@ + + + + + + XHTML 1.0 (Second Edition) Strict in XML Schema + + This is the same as HTML 4 Strict except for + changes due to the differences between XML and SGML. + + Namespace = http://www.w3.org/1999/xhtml + + For further information, see: http://www.w3.org/TR/xhtml1 + + Copyright (c) 1998-2002 W3C (MIT, INRIA, Keio), + All Rights Reserved. + + The DTD version is identified by the PUBLIC and SYSTEM identifiers: + + PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" + + _id: xhtml1-strict.xsd,v 1.2 2002/08/28 08:05:44 mimasa Exp $ + + + + + + ================ Character mnemonic entities ========================= + + XHTML entity sets are identified by the PUBLIC and SYSTEM identifiers: + + PUBLIC "-//W3C//ENTITIES Latin 1 for XHTML//EN" + SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent" + + PUBLIC "-//W3C//ENTITIES Special for XHTML//EN" + SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml-special.ent" + + PUBLIC "-//W3C//ENTITIES Symbols for XHTML//EN" + SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml-symbol.ent" + + + + + ================== Imported Names ==================================== + + + + + + media type, as per [RFC2045] + + + + + + + + comma-separated list of media types, as per [RFC2045] + + + + + + + + a character encoding, as per [RFC2045] + + + + + + + + a space separated list of character encodings, as per [RFC2045] + + + + + + + + a language code, as per [RFC3066] + + + + + + + + a single character, as per section 2.2 of [XML] + + + + + + + + + + one or more digits + + + + + + + + + + tabindex attribute specifies the position of the current element + in the tabbing order for the current document. This value must be + a number between 0 and 32767. User agents should ignore leading zeros. + + + + + + + + + + + space-separated list of link types + + + + + + + + single or comma-separated list of media descriptors + + + + + + + + + + a Uniform Resource Identifier, see [RFC2396] + + + + + + + + a space separated list of Uniform Resource Identifiers + + + + + + + + date and time information. ISO date format + + + + + + + + script expression + + + + + + + + style sheet data + + + + + + + + used for titles etc. + + + + + + + + nn for pixels or nn% for percentage length + + + + + + + + + + pixel, percentage, or relative + + + + + + + + + + integer representing length in pixels + + + + + + + these are used for image maps + + + + + + + + + + + + + + comma separated list of lengths + + + + + + + + + =================== Generic Attributes =============================== + + + + + + core attributes common to most elements + id document-wide unique id + class space separated list of classes + style associated style info + title advisory title/amplification + + + + + + + + + + + internationalization attributes + lang language code (backwards compatible) + xml:lang language code (as per XML 1.0 spec) + dir direction for weak/neutral text + + + + + + + + + + + + + + + + + attributes for common UI events + onclick a pointer button was clicked + ondblclick a pointer button was double clicked + onmousedown a pointer button was pressed down + onmouseup a pointer button was released + onmousemove a pointer was moved onto the element + onmouseout a pointer was moved away from the element + onkeypress a key was pressed and released + onkeydown a key was pressed down + onkeyup a key was released + + + + + + + + + + + + + + + + + attributes for elements that can get the focus + accesskey accessibility key character + tabindex position in tabbing order + onfocus the element got the focus + onblur the element lost the focus + + + + + + + + + + + + + + + =================== Text Elements ==================================== + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + these can only occur at block level + + + + + + + + + + + + + + + + + + + + "Inline" covers inline or "text-level" elements + + + + + + + + + + ================== Block level elements ============================== + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + "Flow" mixes block and inline and is used for list items etc. + + + + + + + + + + + + ================== Content models for exclusions ===================== + + + + + + a elements use "Inline" excluding a + + + + + + + + + + + + + + pre uses "Inline" excluding big, small, sup or sup + + + + + + + + + + + + + + + form uses "Block" excluding form + + + + + + + + + + + button uses "Flow" but excludes a, form and form controls + + + + + + + + + + + + + + + + + + ================ Document Structure ================================== + + + + + + + + + + + + + + + ================ Document Head ======================================= + + + + + + + + + + + + + + + + + content model is "head.misc" combined with a single + title and an optional base element in any order + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The title element is not considered part of the flow of text. + It should be displayed, for example as the page header or + window title. Exactly one title is required per document. + + + + + + + + + + + document base URI + + + + + + + + + + + generic metainformation + + + + + + + + + + + + + + + Relationship values can be used in principle: + + a) for document specific toolbars/menus when used + with the link element in document head e.g. + start, contents, previous, next, index, end, help + b) to link to a separate style sheet (rel="stylesheet") + c) to make a link to a script (rel="script") + d) by stylesheets to control how collections of + html nodes are rendered into printed documents + e) to make a link to a printable version of this document + e.g. a PostScript or PDF version (rel="alternate" media="print") + + + + + + + + + + + + + + + + + style info, which may include CDATA sections + + + + + + + + + + + + + + + script statements, which may include CDATA sections + + + + + + + + + + + + + + + + + + + + + alternate content container for non script-based rendering + + + + + + + + + + + + + =================== Document Body ==================================== + + + + + + + + + + + + + + + + + generic language/style container + + + + + + + + + + + + + =================== Paragraphs ======================================= + + + + + + + + + + + + + + =================== Headings ========================================= + + There are six levels of headings from h1 (the most important) + to h6 (the least important). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + =================== Lists ============================================ + + + + + + Unordered list + + + + + + + + + + + + + Ordered (numbered) list + + + + + + + + + + + + + list item + + + + + + + + + + + + + definition lists - dt for term, dd for its definition + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + =================== Address ========================================== + + + + + + information on author + + + + + + + + + + + + + =================== Horizontal Rule ================================== + + + + + + + + + + =================== Preformatted Text ================================ + + + + + + content is "Inline" excluding "img|object|big|small|sub|sup" + + + + + + + + + + + + + + =================== Block-like Quotes ================================ + + + + + + + + + + + + + + + =================== Inserted/Deleted Text ============================ + + ins/del are allowed in block and inline content, but its + inappropriate to include block content within an ins element + occurring in inline content. + + + + + + + + + + + + + + + + + + + + + + + + + + + ================== The Anchor Element ================================ + + + + + + content is "Inline" except that anchors shouldn't be nested + + + + + + + + + + + + + + + + + + + + + + + ===================== Inline Elements ================================ + + + + + + generic language/style container + + + + + + + + + + + + + + I18N BiDi over-ride + + + + + + + + + + + + + + + + + + + + + + + + + forced line break + + + + + + + + + + emphasis + + + + + + + + + + + + + + strong emphasis + + + + + + + + + + + + + + definitional + + + + + + + + + + + + + + program code + + + + + + + + + + + + + + sample + + + + + + + + + + + + + + something user would type + + + + + + + + + + + + + + variable + + + + + + + + + + + + + + citation + + + + + + + + + + + + + + abbreviation + + + + + + + + + + + + + + acronym + + + + + + + + + + + + + + inlined quote + + + + + + + + + + + + + + + subscript + + + + + + + + + + + + + + superscript + + + + + + + + + + + + + + fixed pitch font + + + + + + + + + + + + + + italic font + + + + + + + + + + + + + + bold font + + + + + + + + + + + + + + bigger font + + + + + + + + + + + + + + smaller font + + + + + + + + + + + + + ==================== Object ====================================== + + object is used to embed objects as part of HTML pages. + param elements should precede other content. Parameters + can also be expressed as attribute/value pairs on the + object element itself when brevity is desired. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + param is used to supply a named property value. + In XML it would seem natural to follow RDF and support an + abbreviated syntax where the param elements are replaced + by attribute value pairs on the object start tag. + + + + + + + + + + + + + + + + + + + + + =================== Images =========================================== + + To avoid accessibility problems for people who aren't + able to see the image, you should provide a text + description using the alt and longdesc attributes. + In addition, avoid the use of server-side image maps. + Note that in this DTD there is no name attribute. That + is only available in the transitional and frameset DTD. + + + + + + + + + + + + + + usemap points to a map element which may be in this document + or an external document, although the latter is not widely supported + + + + + + + + + + + + + + + ================== Client-side image maps ============================ + + These can be placed in the same document or grouped in a + separate document although this isn't yet widely supported + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ================ Forms =============================================== + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Each label must not contain more than ONE field + Label elements shouldn't be nested. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + form control + + + + + + + + + + the name attribute is required for all but submit & reset + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + option selector + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + option group + + + + + + + + + + + + + + + + + + + + + selectable choice + + + + + + + + + + + + + + + + + + + + + + + + + + multi-line text field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The fieldset element is used to group form fields. + Only one legend element should occur in the content + and if present should only be preceded by whitespace. + + NOTE: this content model is different from the XHTML 1.0 DTD, + closer to the intended content model in HTML4 DTD + + + + + + + + + + + + + + + + + + + fieldset label + + + + + + + + + + + + + + + Content is "Flow" excluding a, form and form controls + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ======================= Tables ======================================= + + Derived from IETF HTML table standard, see [RFC1942] + + + + + + The border attribute sets the thickness of the frame around the + table. The default units are screen pixels. + + The frame attribute specifies which parts of the frame around + the table should be rendered. The values are not the same as + CALS to avoid a name clash with the valign attribute. + + + + + + + + + + + + + + + + + + The rules attribute defines which rules to draw between cells: + + If rules is absent then assume: + "none" if border is absent or border="0" otherwise "all" + + + + + + + + + + + + + + horizontal alignment attributes for cell contents + + char alignment char, e.g. char=':' + charoff offset for alignment char + + + + + + + + + + + + + + + + + + + + vertical alignment attributes for cell contents + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Use thead to duplicate headers when breaking table + across page boundaries, or for static headers when + tbody sections are rendered in scrolling panel. + + Use tfoot to duplicate footers when breaking table + across page boundaries, or for static footers when + tbody sections are rendered in scrolling panel. + + Use multiple tbody sections when rules are needed + between groups of table rows. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + colgroup groups a set of col elements. It allows you to group + several semantically related columns together. + + + + + + + + + + + + + + + + + col elements define the alignment properties for cells in + one or more columns. + + The width attribute specifies the width of the columns, e.g. + + width=64 width in screen pixels + width=0.5* relative width of 0.5 + + The span attribute causes the attributes of one + col element to apply to more than one column. + + + + + + + + + + + + + + + + + + + + + + + + + Scope is simpler than headers attribute for common tables + + + + + + + + + + + + th is for headers, td for data and for cells acting as both + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xml.xsd b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xml.xsd new file mode 100644 index 00000000000..efe005d46d8 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xml.xsd @@ -0,0 +1,272 @@ + + + + + + +
+

About the XML namespace

+
+

+ This schema document describes the XML namespace, in a form + suitable for import by other schema documents. +

+

+ See + http://www.w3.org/XML/1998/namespace.html and + + http://www.w3.org/TR/REC-xml for information + about this namespace. +

+

+ Note that local names in this namespace are intended to be + defined only by the World Wide Web Consortium or its subgroups. + The names currently defined in this namespace are listed below. + They should not be used with conflicting semantics by any Working + Group, specification, or document instance. +

+

+ See further below in this document for more information about how to refer to this schema document from your own + XSD schema documents and about the + namespace-versioning policy governing this schema document. +

+
+
+ + + + + +
+

lang (as an attribute name)

+

+ denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification.

+
+
+

Notes

+

+ Attempting to install the relevant ISO 2- and 3-letter + codes as the enumerated possible values is probably never + going to be a realistic possibility. +

+

+ See BCP 47 at + http://www.rfc-editor.org/rfc/bcp/bcp47.txt + and the IANA language subtag registry at + + http://www.iana.org/assignments/language-subtag-registry + for further information. +

+

+ The union allows for the 'un-declaration' of xml:lang with + the empty string. +

+
+ + + + + + + + + + + + + + + +
+

space (as an attribute name)

+

+ denotes an attribute whose + value is a keyword indicating what whitespace processing + discipline is intended for the content of the element; its + value is inherited. This name is reserved by virtue of its + definition in the XML specification.

+
+ + + + + + + + + + + + +
+

base (as an attribute name)

+

+ denotes an attribute whose value + provides a URI to be used as the base for interpreting any + relative URIs in the scope of the element on which it + appears; its value is inherited. This name is reserved + by virtue of its definition in the XML Base specification.

+

+ See http://www.w3.org/TR/xmlbase/ + for information about this attribute. +

+
+ + + + + + +
+

id (as an attribute name)

+

+ denotes an attribute whose value + should be interpreted as if declared to be of type ID. + This name is reserved by virtue of its definition in the + xml:id specification.

+

+ See http://www.w3.org/TR/xml-id/ + for information about this attribute. +

+
+ + + + + + + + + + + +
+

Father (in any context at all)

+
+

+ denotes Jon Bosak, the chair of + the original XML Working Group. This name is reserved by + the following decision of the W3C XML Plenary and + XML Coordination groups: +

+
+

+ In appreciation for his vision, leadership and + dedication the W3C XML Plenary on this 10th day of + February, 2000, reserves for Jon Bosak in perpetuity + the XML name "xml:Father". +

+
+
+
+ + + + +
+

+ About this schema document +

+
+

+ This schema defines attributes and an attribute group suitable + for use by schemas wishing to allow xml:base, + xml:lang, xml:space or + xml:id attributes on elements they define. +

+

+ To enable this, such a schema must import this schema for + the XML namespace, e.g. as follows: +

+ 
+          <schema . . .>
+           . . .
+           <import namespace="http://www.w3.org/XML/1998/namespace"
+                      schemaLocation="http://www.w3.org/2001/xml.xsd"/>
+
+

+ or +

+ 
+           <import namespace="http://www.w3.org/XML/1998/namespace"
+                      schemaLocation="http://www.w3.org/2009/01/xml.xsd"/>
+
+

+ Subsequently, qualified reference to any of the attributes or the + group defined below will have the desired effect, e.g. +

+ 
+          <type . . .>
+           . . .
+           <attributeGroup ref="xml:specialAttrs"/>
+
+

+ will define a type which will schema-validate an instance element + with any of those attributes. +

+
+
+ + + + +
+

+ Versioning policy for this schema document +

+
+

+ In keeping with the XML Schema WG's standard versioning + policy, this schema document will persist at + + http://www.w3.org/2009/01/xml.xsd. +

+

+ At the date of issue it can also be found at + + http://www.w3.org/2001/xml.xsd. +

+

+ The schema document at that URI may however change in the future, + in order to remain compatible with the latest version of XML + Schema itself, or with the XML namespace itself. In other words, + if the XML Schema or XML namespaces change, the version of this + document at + http://www.w3.org/2001/xml.xsd + + will change accordingly; the version at + + http://www.w3.org/2009/01/xml.xsd + + will not change. +

+

+ Previous dated (and unchanging) versions of this schema + document are at: +

+ +
+
+ + + diff --git a/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xmldsig-core-schema.xsd b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xmldsig-core-schema.xsd new file mode 100644 index 00000000000..555a88bdbc9 --- /dev/null +++ b/hapi-fhir-base/src/main/resources/ca/uhn/fhir/model/dstu/resource/xmldsig-core-schema.xsd @@ -0,0 +1,254 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/hapi-fhir-base/src/site/site.xml b/hapi-fhir-base/src/site/site.xml index 6ce7a5bd2fd..6ed7eff4881 100644 --- a/hapi-fhir-base/src/site/site.xml +++ b/hapi-fhir-base/src/site/site.xml @@ -62,6 +62,7 @@ + diff --git a/hapi-fhir-base/src/site/xdoc/doc_validation.xml b/hapi-fhir-base/src/site/xdoc/doc_validation.xml new file mode 100644 index 00000000000..b8bf9a0d28e --- /dev/null +++ b/hapi-fhir-base/src/site/xdoc/doc_validation.xml @@ -0,0 +1,67 @@ + + + + + Validation - HAPI FHIR + James Agnew + + + + + +
+ + + + +

+ HAPI provides a built-in and configurable mechanism for validating resources. + This mechanism is called the Resource Validator. +

+ + + +

+ FHIR resource definitions are distributed with a set of XML schema files (XDS) + as well as a set of XML Schematron (SCH) files. These two sets of files are + complimentary to each other, meaning that in order to claim compliance to the + FHIR specification, your resources must validate against both sets. +

+

+ The two sets of files are included with HAPI, and it uses them to perform + validation. +

+ + + + + +

+ In order to use HAPI's Schematron support, a libaray called + Phloc-Schematron + is used, so this library must be added to your classpath (or Maven pom file). + See Downloads for more information. +

+ + + + + +

+ To validate a resource instance, a new validator instance is requested + from the FHIR Context. This validator is then applied against + a specific resource instance, as shown in the example below. +

+ + + + + + + +
+ + + + diff --git a/hapi-fhir-base/src/test/java/ca/uhn/fhir/context/ModelScannerTest.java b/hapi-fhir-base/src/test/java/ca/uhn/fhir/context/ModelScannerTest.java index 5fbe6693248..00018828684 100644 --- a/hapi-fhir-base/src/test/java/ca/uhn/fhir/context/ModelScannerTest.java +++ b/hapi-fhir-base/src/test/java/ca/uhn/fhir/context/ModelScannerTest.java @@ -21,10 +21,13 @@ public class ModelScannerTest { public void testExtendedClass() { FhirContext ctx = new FhirContext(); ctx.getResourceDefinition(MyPatient.class); - ctx.getResourceDefinition(Patient.class); RuntimeResourceDefinition patient = ctx.getResourceDefinition("Patient"); assertEquals(Patient.class, patient.getImplementingClass()); + + RuntimeResourceDefinition def = ctx.getResourceDefinition(MyPatient.class); + RuntimeResourceDefinition baseDef = def.getBaseDefinition(); + assertEquals(Patient.class,baseDef.getImplementingClass()); } diff --git a/hapi-fhir-base/src/test/java/ca/uhn/fhir/validation/ResourceValidatorTest.java b/hapi-fhir-base/src/test/java/ca/uhn/fhir/validation/ResourceValidatorTest.java new file mode 100644 index 00000000000..75ff3ea0ac7 --- /dev/null +++ b/hapi-fhir-base/src/test/java/ca/uhn/fhir/validation/ResourceValidatorTest.java @@ -0,0 +1,71 @@ +package ca.uhn.fhir.validation; + +import static org.hamcrest.Matchers.*; +import static org.junit.Assert.*; + +import java.io.IOException; + +import org.apache.commons.io.IOUtils; +import org.junit.Test; + +import ca.uhn.fhir.context.FhirContext; +import ca.uhn.fhir.model.dstu.resource.Patient; +import ca.uhn.fhir.model.dstu.valueset.ContactSystemEnum; + +public class ResourceValidatorTest { + + private static FhirContext ourCtx = new FhirContext(); + private static final org.slf4j.Logger ourLog = org.slf4j.LoggerFactory.getLogger(ResourceValidatorTest.class); + + @Test + public void testSchemaValidator() throws IOException { + String res = IOUtils.toString(getClass().getClassLoader().getResourceAsStream("patient-example-dicom.xml")); + Patient p = ourCtx.newXmlParser().parseResource(Patient.class, res); + + ResourceValidator val = ourCtx.newValidator(); + val.setValidateBaseSchema(true); + val.setValidateBaseSchematron(false); + + val.validate(p); + + p.getAnimal().getBreed().setText("The Breed"); + try { + val.validate(p); + fail(); + } catch (ValidationFailureException e) { + ourLog.info(ourCtx.newXmlParser().setPrettyPrint(true).encodeResourceToString(e.getOperationOutcome())); + assertEquals(1, e.getOperationOutcome().getIssue().size()); + assertThat(e.getOperationOutcome().getIssueFirstRep().getDetails().getValue(), containsString("Invalid content was found starting with element 'breed'")); + } + } + + + @Test + public void testSchematronValidator() throws IOException { +// System.setProperty("javax.xml.transform.TransformerFactory", "org.apache.xalan.processor.TransformerFactoryImpl "); +// System.setProperty("javax.xml.transform.TransformerFactory", "net.sf.saxon.TransformerFactoryImpl"); + + String res = IOUtils.toString(getClass().getClassLoader().getResourceAsStream("patient-example-dicom.xml")); + Patient p = ourCtx.newXmlParser().parseResource(Patient.class, res); + + ResourceValidator val = ourCtx.newValidator(); + val.setValidateBaseSchema(false); + val.setValidateBaseSchematron(true); + + val.validate(p); + + p.getTelecomFirstRep().setValue("123-4567"); + try { + val.validate(p); + fail(); + } catch (ValidationFailureException e) { + ourLog.info(ourCtx.newXmlParser().setPrettyPrint(true).encodeResourceToString(e.getOperationOutcome())); + assertEquals(1, e.getOperationOutcome().getIssue().size()); + assertThat(e.getOperationOutcome().getIssueFirstRep().getDetails().getValue(), containsString("Inv-2: A system is required if a value is provided.")); + } + + p.getTelecomFirstRep().setSystem(ContactSystemEnum.EMAIL); + val.validate(p); + } + +} diff --git a/hapi-fhir-jpaserver-uhnfhirtest/.settings/org.eclipse.wst.common.component b/hapi-fhir-jpaserver-uhnfhirtest/.settings/org.eclipse.wst.common.component index c94187882b4..ee477891317 100644 --- a/hapi-fhir-jpaserver-uhnfhirtest/.settings/org.eclipse.wst.common.component +++ b/hapi-fhir-jpaserver-uhnfhirtest/.settings/org.eclipse.wst.common.component @@ -12,7 +12,7 @@ uses - + consumes diff --git a/pom.xml b/pom.xml index 4036cfbfd49..fef4313423d 100644 --- a/pom.xml +++ b/pom.xml @@ -83,6 +83,7 @@ 3.4 1.1.8 1.9.5 + 2.7.1 UTF-8 1.7.7 4.0.1.RELEASE diff --git a/restful-server-example/.settings/org.eclipse.wst.common.component b/restful-server-example/.settings/org.eclipse.wst.common.component index 263e87f0f0d..e2cd387d6d8 100644 --- a/restful-server-example/.settings/org.eclipse.wst.common.component +++ b/restful-server-example/.settings/org.eclipse.wst.common.component @@ -6,7 +6,7 @@ uses - + consumes