{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/aetna/refs/heads/main/json-schema/aetna-patient.json", "title": "Aetna FHIR R4 Patient", "description": "JSON Schema for the FHIR R4 Patient resource as Aetna profiles it. Derived mechanically from the components.schemas of openapi/aetna-patient-access-api-openapi.yml, which is assembled from the Swagger 2.0 documents Aetna publishes at https://developerportal.aetna.com/managedcontent/yaml/. Not authored - every constraint here is Aetna's. $refs rewritten from #/components/schemas/ to #/$defs/.", "x-provenance": { "generated": "2026-08-30", "method": "derived", "source": "openapi/aetna-patient-access-api-openapi.yml" }, "allOf": [ { "$ref": "#/$defs/DomainResource" }, { "type": "object", "properties": { "identifier": { "description": "An identifier for this patient.", "type": "array", "items": { "$ref": "#/$defs/Identifier" } }, "address": { "description": "An address for the individual.", "type": "array", "items": { "$ref": "#/$defs/Address" } }, "gender": { "description": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.", "type": "string", "enum": [ "male", "female", "other", "unknown" ] }, "multipleBirthBoolean": { "description": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).", "type": "boolean" }, "link": { "description": "Link to another patient resource that concerns the same actual patient.", "type": "array", "items": { "$ref": "#/$defs/Patient_Link" } }, "active": { "description": "Whether this patient record is in active use.\nMany systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.\n\nIt is often used to filter patient lists to exclude inactive patients\n\nDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.", "type": "boolean" }, "photo": { "description": "Image of the patient.", "type": "array", "items": { "$ref": "#/$defs/Attachment" } }, "birthDate": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", "description": "The date of birth for the individual.", "type": "string" }, "deceasedBoolean": { "description": "Indicates if the individual is deceased or not.", "type": "boolean" }, "managingOrganization": { "description": "Organization that is the custodian of the patient record.", "$ref": "#/$defs/Reference" }, "multipleBirthInteger": { "format": "int32", "description": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).", "type": "integer" }, "deceasedDateTime": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", "description": "Indicates if the individual is deceased or not.", "type": "string" }, "contact": { "description": "A contact party (e.g. guardian, partner, friend) for the patient.", "type": "array", "items": { "$ref": "#/$defs/Patient_Contact" } }, "generalPractitioner": { "description": "Patient's nominated care provider.", "type": "array", "items": { "$ref": "#/$defs/Reference" } }, "name": { "description": "A name associated with the individual.", "type": "array", "items": { "$ref": "#/$defs/HumanName" } }, "telecom": { "description": "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.", "type": "array", "items": { "$ref": "#/$defs/ContactPoint" } }, "communication": { "description": "A language which may be used to communicate with the patient about his or her health.", "type": "array", "items": { "$ref": "#/$defs/Patient_Communication" } }, "maritalStatus": { "description": "This field contains a patient's most recent marital (civil) status.", "$ref": "#/$defs/CodeableConcept" } } } ], "$defs": { "Address": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "country": { "pattern": "[ \\r\\n\\t\\S]+", "description": "Country - a nation as commonly understood or generally accepted.", "type": "string" }, "period": { "description": "Time period when address was/is in use.", "$ref": "#/$defs/Period" }, "city": { "pattern": "[ \\r\\n\\t\\S]+", "description": "The name of the city, town, suburb, village or other community or delivery center.", "type": "string" }, "use": { "description": "The purpose of this address.", "type": "string", "enum": [ "home", "work", "temp", "old", "billing" ] }, "line": { "description": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.", "type": "array", "items": { "pattern": "[ \\r\\n\\t\\S]+", "type": "string" } }, "district": { "pattern": "[ \\r\\n\\t\\S]+", "description": "The name of the administrative area (county).", "type": "string" }, "postalCode": { "pattern": "[ \\r\\n\\t\\S]+", "description": "A postal code designating a region defined by the postal service.", "type": "string" }, "text": { "pattern": "[ \\r\\n\\t\\S]+", "description": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.", "type": "string" }, "state": { "pattern": "[ \\r\\n\\t\\S]+", "description": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).", "type": "string" }, "type": { "description": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.", "type": "string", "enum": [ "postal", "physical", "both" ] } } } ] }, "Age": { "allOf": [ { "$ref": "#/$defs/Quantity" }, { "type": "object" } ] }, "Annotation": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "required": [ "text" ], "properties": { "authorString": { "pattern": "[ \\r\\n\\t\\S]+", "description": "The individual responsible for making the annotation.", "type": "string" }, "authorReference": { "description": "The individual responsible for making the annotation.", "$ref": "#/$defs/Reference" }, "time": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", "description": "Indicates when this particular annotation was made.", "type": "string" }, "text": { "pattern": "[ \\r\\n\\t\\S]+", "description": "The text of the annotation in markdown format.", "type": "string" } } } ] }, "Attachment": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "data": { "pattern": "(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+", "description": "The actual data of the attachment - a sequence of bytes, base64 encoded.", "type": "string" }, "size": { "format": "int32", "description": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).", "type": "integer" }, "language": { "pattern": "[^\\s]+(\\s[^\\s]+)*", "description": "The human language of the content. The value can be any valid value according to BCP 47.", "type": "string" }, "title": { "pattern": "[ \\r\\n\\t\\S]+", "description": "A label or set of text to display in place of the data.", "type": "string" }, "contentType": { "pattern": "[^\\s]+(\\s[^\\s]+)*", "description": "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.", "type": "string" }, "url": { "pattern": "\\S*", "description": "A location where the data can be accessed.", "type": "string" }, "hash": { "pattern": "(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+", "description": "The calculated hash of the data using SHA-1. Represented using base64.", "type": "string" }, "creation": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", "description": "The date that the attachment was first created.", "type": "string" } } } ] }, "BackboneElement": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "type": "array", "items": { "$ref": "#/$defs/Extension" } } } } ] }, "CodeableConcept": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "coding": { "description": "A reference to a code defined by a terminology system.", "type": "array", "items": { "$ref": "#/$defs/Coding" } }, "text": { "pattern": "[ \\r\\n\\t\\S]+", "description": "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.", "type": "string" } } } ] }, "Coding": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "system": { "pattern": "\\S*", "description": "The identification of the code system that defines the meaning of the symbol in the code.", "type": "string" }, "code": { "pattern": "[^\\s]+(\\s[^\\s]+)*", "description": "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).", "type": "string" }, "userSelected": { "description": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "type": "boolean" }, "display": { "pattern": "[ \\r\\n\\t\\S]+", "description": "A representation of the meaning of the code in the system, following the rules of the system.", "type": "string" }, "version": { "pattern": "[ \\r\\n\\t\\S]+", "description": "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.", "type": "string" } } } ] }, "ContactDetail": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "name": { "pattern": "[ \\r\\n\\t\\S]+", "description": "The name of an individual to contact.", "type": "string" }, "telecom": { "description": "The contact details for the individual (if a name was provided) or the organization.", "type": "array", "items": { "$ref": "#/$defs/ContactPoint" } } } } ] }, "ContactPoint": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "period": { "description": "Time period when the contact point was/is in use.", "$ref": "#/$defs/Period" }, "system": { "description": "Telecommunications form for contact point - what communications system is required to make use of the contact.", "type": "string", "enum": [ "phone", "fax", "email", "pager", "url", "sms", "other" ] }, "use": { "description": "Identifies the purpose for the contact point.", "type": "string", "enum": [ "home", "work", "temp", "old", "mobile" ] }, "rank": { "format": "int32", "description": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.", "type": "integer" }, "value": { "pattern": "[ \\r\\n\\t\\S]+", "description": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).", "type": "string" } } } ] }, "Count": { "allOf": [ { "$ref": "#/$defs/Quantity" }, { "type": "object" } ] }, "Distance": { "allOf": [ { "$ref": "#/$defs/Quantity" }, { "type": "object" } ] }, "DomainResource": { "allOf": [ { "$ref": "#/$defs/Resource" }, { "type": "object", "properties": { "contained": { "description": "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.", "type": "array", "items": { "$ref": "#/$defs/Resource" } }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "type": "array", "items": { "$ref": "#/$defs/Extension" } }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "type": "array", "items": { "$ref": "#/$defs/Extension" } }, "text": { "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "$ref": "#/$defs/Narrative" } } } ] }, "Duration": { "allOf": [ { "$ref": "#/$defs/Quantity" }, { "type": "object" } ] }, "Element": { "type": "object", "properties": { "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "type": "array", "items": { "$ref": "#/$defs/Extension" } }, "id": { "pattern": "[A-Za-z0-9\\-\\.]{1,64}", "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "type": "string" } } }, "Extension": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "required": [ "url" ], "properties": { "valueBase64Binary": { "pattern": "(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valueBoolean": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "boolean" }, "valueCoding": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Coding" }, "valueTime": { "pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valueIdentifier": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Identifier" }, "valueReference": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Reference" }, "valueMoney": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Money" }, "valueRange": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Range" }, "valueSignature": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Signature" }, "valueUri": { "pattern": "\\S*", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valueDistance": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Distance" }, "valueUrl": { "pattern": "\\S*", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valueContactDetail": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/ContactDetail" }, "valueMeta": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Meta" }, "valueUuid": { "pattern": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valueCodeableConcept": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/CodeableConcept" }, "valueRatio": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Ratio" }, "valueMarkdown": { "pattern": "[ \\r\\n\\t\\S]+", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valueAttachment": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Attachment" }, "valueUsageContext": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/UsageContext" }, "valueDateTime": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valueInteger": { "format": "int32", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "integer" }, "valueUnsignedInt": { "format": "int32", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "integer" }, "valueHumanName": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/HumanName" }, "valueQuantity": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Quantity" }, "valueRelatedArtifact": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/RelatedArtifact" }, "valueCanonical": { "pattern": "\\S*", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valueCount": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Count" }, "valueId": { "pattern": "[A-Za-z0-9\\-\\.]{1,64}", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valueDecimal": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "number" }, "valueCode": { "pattern": "[^\\s]+(\\s[^\\s]+)*", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valueDate": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valueOid": { "pattern": "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "url": { "pattern": "\\S*", "description": "Source of the definition for the extension code - a logical name or a URL.", "type": "string" }, "valueAddress": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Address" }, "valueContactPoint": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/ContactPoint" }, "valueString": { "pattern": "[ \\r\\n\\t\\S]+", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valuePeriod": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Period" }, "valueSampledData": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/SampledData" }, "valueTiming": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Timing" }, "valueInstant": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "string" }, "valuePositiveInt": { "format": "int32", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "type": "integer" }, "valueDuration": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Duration" }, "valueAge": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Age" }, "valueAnnotation": { "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "$ref": "#/$defs/Annotation" } } } ] }, "HumanName": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "given": { "description": "Given name.", "type": "array", "items": { "pattern": "[ \\r\\n\\t\\S]+", "type": "string" } }, "period": { "description": "Indicates the period of time when this name was valid for the named person.", "$ref": "#/$defs/Period" }, "use": { "description": "Identifies the purpose for this name.", "type": "string", "enum": [ "usual", "official", "temp", "nickname", "anonymous", "old", "maiden" ] }, "prefix": { "description": "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.", "type": "array", "items": { "pattern": "[ \\r\\n\\t\\S]+", "type": "string" } }, "text": { "pattern": "[ \\r\\n\\t\\S]+", "description": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.", "type": "string" }, "family": { "pattern": "[ \\r\\n\\t\\S]+", "description": "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.", "type": "string" }, "suffix": { "description": "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.", "type": "array", "items": { "pattern": "[ \\r\\n\\t\\S]+", "type": "string" } } } } ] }, "Identifier": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "period": { "description": "Time period during which identifier is/was valid for use.", "$ref": "#/$defs/Period" }, "system": { "pattern": "\\S*", "description": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "type": "string" }, "use": { "description": "The purpose of this identifier.", "type": "string", "enum": [ "usual", "official", "temp", "secondary", "old" ] }, "assigner": { "description": "Organization that issued/manages the identifier.", "$ref": "#/$defs/Reference" }, "type": { "description": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "$ref": "#/$defs/CodeableConcept" }, "value": { "pattern": "[ \\r\\n\\t\\S]+", "description": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "type": "string" } } } ] }, "Meta": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "lastUpdated": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", "description": "When the resource last changed - e.g. when the version changed.", "type": "string" }, "versionId": { "pattern": "[A-Za-z0-9\\-\\.]{1,64}", "description": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.", "type": "string" }, "security": { "description": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.", "type": "array", "items": { "$ref": "#/$defs/Coding" } }, "profile": { "description": "A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).", "type": "array", "items": { "pattern": "\\S*", "type": "string" } }, "source": { "pattern": "\\S*", "description": "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.", "type": "string" }, "tag": { "description": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", "type": "array", "items": { "$ref": "#/$defs/Coding" } } } } ] }, "Money": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "currency": { "pattern": "[^\\s]+(\\s[^\\s]+)*", "description": "ISO 4217 Currency Code.", "type": "string" }, "value": { "description": "Numerical value (with implicit precision).", "type": "number" } } } ] }, "Narrative": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "required": [ "div", "status" ], "properties": { "div": { "description": "The actual narrative content, a stripped down version of XHTML.", "type": "string" }, "status": { "description": "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.", "type": "string", "enum": [ "generated", "extensions", "additional", "empty" ] } } } ] }, "Patient_Communication": { "allOf": [ { "$ref": "#/$defs/BackboneElement" }, { "type": "object", "required": [ "language" ], "properties": { "language": { "description": "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.", "$ref": "#/$defs/CodeableConcept" }, "preferred": { "description": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).", "type": "boolean" } } } ] }, "Patient_Contact": { "allOf": [ { "$ref": "#/$defs/BackboneElement" }, { "type": "object", "properties": { "period": { "description": "The period during which this contact person or organization is valid to be contacted relating to this patient.", "$ref": "#/$defs/Period" }, "address": { "description": "Address for the contact person.", "$ref": "#/$defs/Address" }, "gender": { "description": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.", "type": "string", "enum": [ "male", "female", "other", "unknown" ] }, "organization": { "description": "Organization on behalf of which the contact is acting or for which the contact is working.", "$ref": "#/$defs/Reference" }, "name": { "description": "A name associated with the contact person.", "$ref": "#/$defs/HumanName" }, "telecom": { "description": "A contact detail for the person, e.g. a telephone number or an email address.", "type": "array", "items": { "$ref": "#/$defs/ContactPoint" } }, "relationship": { "description": "The nature of the relationship between the patient and the contact person.", "type": "array", "items": { "$ref": "#/$defs/CodeableConcept" } } } } ] }, "Patient_Link": { "allOf": [ { "$ref": "#/$defs/BackboneElement" }, { "type": "object", "required": [ "other", "type" ], "properties": { "other": { "description": "The other patient resource that the link refers to.", "$ref": "#/$defs/Reference" }, "type": { "description": "The type of link between this patient resource and another patient resource.", "type": "string", "enum": [ "replaced-by", "replaces", "refer", "seealso" ] } } } ] }, "Period": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "start": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", "description": "The start of the period. The boundary is inclusive.", "type": "string" }, "end": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", "description": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "type": "string" } } } ] }, "Quantity": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "comparator": { "description": "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 \"<>", "type": "string", "enum": [ "<", "<=", ">=", ">" ] }, "unit": { "pattern": "[ \\r\\n\\t\\S]+", "description": "A human-readable form of the unit.", "type": "string" }, "system": { "pattern": "\\S*", "description": "The identification of the system that provides the coded form of the unit.", "type": "string" }, "code": { "pattern": "[^\\s]+(\\s[^\\s]+)*", "description": "A computer processable form of the unit in some unit representation system.", "type": "string" }, "value": { "description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", "type": "number" } } } ] }, "Range": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "high": { "description": "The high limit. The boundary is inclusive.", "$ref": "#/$defs/SimpleQuantity" }, "low": { "description": "The low limit. The boundary is inclusive.", "$ref": "#/$defs/SimpleQuantity" } } } ] }, "Ratio": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "numerator": { "description": "The value of the numerator.", "$ref": "#/$defs/Quantity" }, "denominator": { "description": "The value of the denominator.", "$ref": "#/$defs/Quantity" } } } ] }, "Reference": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "properties": { "reference": { "pattern": "[ \\r\\n\\t\\S]+", "description": "A reference to a location at which the other resource is found. The reference may be 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.", "type": "string" }, "identifier": { "description": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "$ref": "#/$defs/Identifier" }, "display": { "pattern": "[ \\r\\n\\t\\S]+", "description": "Plain text narrative that identifies the resource in addition to the resource reference.", "type": "string" }, "type": { "pattern": "\\S*", "description": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).", "type": "string" } } } ] }, "RelatedArtifact": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "required": [ "type" ], "properties": { "citation": { "pattern": "[ \\r\\n\\t\\S]+", "description": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.", "type": "string" }, "resource": { "pattern": "\\S*", "description": "The related resource, such as a library, value set, profile, or other knowledge resource.", "type": "string" }, "display": { "pattern": "[ \\r\\n\\t\\S]+", "description": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.", "type": "string" }, "document": { "description": "The document being referenced, represented as an attachment. This is exclusive with the resource element.", "$ref": "#/$defs/Attachment" }, "label": { "pattern": "[ \\r\\n\\t\\S]+", "description": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.", "type": "string" }, "type": { "description": "The type of relationship to the related artifact.", "type": "string", "enum": [ "documentation", "justification", "citation", "predecessor", "successor", "derived-from", "depends-on", "composed-of" ] }, "url": { "pattern": "\\S*", "description": "A url for the artifact that can be followed to access the actual content.", "type": "string" } } } ] }, "Resource": { "type": "object", "required": [ "resourceType" ], "properties": { "meta": { "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "$ref": "#/$defs/Meta" }, "implicitRules": { "pattern": "\\S*", "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "type": "string" }, "language": { "pattern": "[^\\s]+(\\s[^\\s]+)*", "description": "The base language in which the resource is written.", "type": "string" }, "id": { "pattern": "[A-Za-z0-9\\-\\.]{1,64}", "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "type": "string" }, "resourceType": { "type": "string", "enum": [ "Account", "ActivityDefinition", "AdverseEvent", "AllergyIntolerance", "Appointment", "AppointmentResponse", "AuditEvent", "Basic", "Binary", "BiologicallyDerivedProduct", "BodyStructure", "Bundle", "CapabilityStatement", "CarePlan", "CareTeam", "CatalogEntry", "ChargeItem", "ChargeItemDefinition", "Claim", "ClaimResponse", "ClinicalImpression", "CodeSystem", "Communication", "CommunicationRequest", "CompartmentDefinition", "Composition", "ConceptMap", "Condition", "Consent", "Contract", "Coverage", "CoverageEligibilityRequest", "CoverageEligibilityResponse", "DetectedIssue", "Device", "DeviceDefinition", "DeviceMetric", "DeviceRequest", "DeviceUseStatement", "DiagnosticReport", "DocumentManifest", "DocumentReference", "DomainResource", "EffectEvidenceSynthesis", "Encounter", "Endpoint", "EnrollmentRequest", "EnrollmentResponse", "EpisodeOfCare", "EventDefinition", "Evidence", "EvidenceVariable", "ExampleScenario", "ExplanationOfBenefit", "FamilyMemberHistory", "Flag", "Goal", "GraphDefinition", "Group", "GuidanceResponse", "HealthcareService", "ImagingStudy", "Immunization", "ImmunizationEvaluation", "ImmunizationRecommendation", "ImplementationGuide", "InsurancePlan", "Invoice", "Library", "Linkage", "List", "Location", "Measure", "MeasureReport", "Media", "Medication", "MedicationAdministration", "MedicationDispense", "MedicationKnowledge", "MedicationRequest", "MedicationStatement", "MedicinalProduct", "MedicinalProductAuthorization", "MedicinalProductContraindication", "MedicinalProductIndication", "MedicinalProductIngredient", "MedicinalProductInteraction", "MedicinalProductManufactured", "MedicinalProductPackaged", "MedicinalProductPharmaceutical", "MedicinalProductUndesirableEffect", "MessageDefinition", "MessageHeader", "MolecularSequence", "NamingSystem", "NutritionOrder", "Observation", "ObservationDefinition", "OperationDefinition", "OperationOutcome", "Organization", "OrganizationAffiliation", "Parameters", "Patient", "PaymentNotice", "PaymentReconciliation", "Person", "PlanDefinition", "Practitioner", "PractitionerRole", "Procedure", "Provenance", "Questionnaire", "QuestionnaireResponse", "RelatedPerson", "RequestGroup", "ResearchDefinition", "ResearchElementDefinition", "ResearchStudy", "ResearchSubject", "Resource", "RiskAssessment", "RiskEvidenceSynthesis", "Schedule", "SearchParameter", "ServiceRequest", "Slot", "Specimen", "SpecimenDefinition", "StructureDefinition", "StructureMap", "Subscription", "Substance", "SubstanceNucleicAcid", "SubstancePolymer", "SubstanceProtein", "SubstanceReferenceInformation", "SubstanceSourceMaterial", "SubstanceSpecification", "SupplyDelivery", "SupplyRequest", "Task", "TerminologyCapabilities", "TestReport", "TestScript", "ValueSet", "VerificationResult", "VisionPrescription" ] } }, "discriminator": "resourceType" }, "SampledData": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "required": [ "dimensions", "origin", "period" ], "properties": { "period": { "description": "The length of time between sampling times, measured in milliseconds.", "type": "number" }, "data": { "pattern": "[ \\r\\n\\t\\S]+", "description": "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.", "type": "string" }, "origin": { "description": "The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.", "$ref": "#/$defs/SimpleQuantity" }, "upperLimit": { "description": "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).", "type": "number" }, "lowerLimit": { "description": "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).", "type": "number" }, "factor": { "description": "A correction factor that is applied to the sampled data points before they are added to the origin.", "type": "number" }, "dimensions": { "format": "int32", "description": "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.", "type": "integer" } } } ] }, "Signature": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "required": [ "type", "when", "who" ], "properties": { "data": { "pattern": "(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+", "description": "The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.", "type": "string" }, "onBehalfOf": { "description": "A reference to an application-usable description of the identity that is represented by the signature.", "$ref": "#/$defs/Reference" }, "sigFormat": { "pattern": "[^\\s]+(\\s[^\\s]+)*", "description": "A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.", "type": "string" }, "targetFormat": { "pattern": "[^\\s]+(\\s[^\\s]+)*", "description": "A mime type that indicates the technical format of the target resources signed by the signature.", "type": "string" }, "type": { "minItems": 1, "description": "An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.", "type": "array", "items": { "$ref": "#/$defs/Coding" } }, "when": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", "description": "When the digital signature was signed.", "type": "string" }, "who": { "description": "A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).", "$ref": "#/$defs/Reference" } } } ] }, "SimpleQuantity": { "allOf": [ { "$ref": "#/$defs/Quantity" }, { "type": "object" } ] }, "Timing": { "allOf": [ { "$ref": "#/$defs/BackboneElement" }, { "type": "object", "properties": { "code": { "description": "A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).", "$ref": "#/$defs/CodeableConcept" }, "repeat": { "description": "A set of rules that describe when the event is scheduled.", "$ref": "#/$defs/Timing_Repeat" }, "event": { "description": "Identifies specific times when the event occurs.", "type": "array", "items": { "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", "type": "string" } } } } ] }, "Timing_Repeat": { "allOf": [ { "$ref": "#/$defs/BackboneElement" }, { "type": "object", "properties": { "boundsRange": { "description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.", "$ref": "#/$defs/Range" }, "period": { "description": "Indicates the duration of time over which repetitions are to occur; e.g. to express \"3 times per day\", 3 would be the frequency and \"1 day\" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.", "type": "number" }, "offset": { "format": "int32", "description": "The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.", "type": "integer" }, "frequencyMax": { "format": "int32", "description": "If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.", "type": "integer" }, "countMax": { "format": "int32", "description": "If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.", "type": "integer" }, "periodMax": { "description": "If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as \"do this once every 3-5 days.", "type": "number" }, "count": { "format": "int32", "description": "A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.", "type": "integer" }, "periodUnit": { "description": "The units of time for the period in UCUM units.", "type": "string", "enum": [ "s", "min", "h", "d", "wk", "mo", "a" ] }, "when": { "description": "An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.", "type": "array", "items": { "type": "string" } }, "frequency": { "format": "int32", "description": "The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.", "type": "integer" }, "boundsDuration": { "description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.", "$ref": "#/$defs/Duration" }, "duration": { "description": "How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.", "type": "number" }, "durationMax": { "description": "If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.", "type": "number" }, "dayOfWeek": { "description": "If one or more days of week is provided, then the action happens only on the specified day(s).", "type": "array", "items": { "type": "string" } }, "boundsPeriod": { "description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.", "$ref": "#/$defs/Period" }, "durationUnit": { "description": "The units of time for the duration, in UCUM units.", "type": "string", "enum": [ "s", "min", "h", "d", "wk", "mo", "a" ] }, "timeOfDay": { "description": "Specified time of day for action to take place.", "type": "array", "items": { "pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?", "type": "string" } } } } ] }, "UsageContext": { "allOf": [ { "$ref": "#/$defs/Element" }, { "type": "object", "required": [ "code" ], "properties": { "valueCodeableConcept": { "description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.", "$ref": "#/$defs/CodeableConcept" }, "code": { "description": "A code that identifies the type of context being specified by this usage context.", "$ref": "#/$defs/Coding" }, "valueReference": { "description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.", "$ref": "#/$defs/Reference" }, "valueRange": { "description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.", "$ref": "#/$defs/Range" }, "valueQuantity": { "description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.", "$ref": "#/$defs/Quantity" } } } ] } } }