usersecurityrequest.json•8.21 kB
{
"name": "UserSecurityRequest",
"location": "medplum",
"description": "User security request for the 'forgot password' flow, email verification, etc.",
"properties": [
{
"name": "UserSecurityRequest",
"depth": 0,
"types": [
{
"datatype": ""
}
],
"path": "UserSecurityRequest",
"min": 0,
"max": "*",
"short": "User security request for the 'forgot password' flow, email verification, etc.",
"definition": "User security request for the 'forgot password' flow, email verification, etc.",
"comment": "",
"inherited": false
},
{
"name": "id",
"depth": 1,
"types": [
{
"datatype": "string"
}
],
"path": "UserSecurityRequest.id",
"min": 0,
"max": "1",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "",
"inherited": true,
"base": "Resource"
},
{
"name": "meta",
"depth": 1,
"types": [
{
"datatype": "Meta",
"documentLocation": "datatype"
}
],
"path": "UserSecurityRequest.meta",
"min": 0,
"max": "1",
"short": "",
"definition": "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.",
"comment": "",
"inherited": true,
"base": "Resource"
},
{
"name": "implicitRules",
"depth": 1,
"types": [
{
"datatype": "uri"
}
],
"path": "UserSecurityRequest.implicitRules",
"min": 0,
"max": "1",
"short": "",
"definition": "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.",
"comment": "",
"inherited": true,
"base": "Resource"
},
{
"name": "language",
"depth": 1,
"types": [
{
"datatype": "code"
}
],
"path": "UserSecurityRequest.language",
"min": 0,
"max": "1",
"short": "",
"definition": "The base language in which the resource is written.",
"comment": "",
"inherited": true,
"base": "Resource"
},
{
"name": "text",
"depth": 1,
"types": [
{
"datatype": "Narrative",
"documentLocation": "datatype"
}
],
"path": "UserSecurityRequest.text",
"min": 0,
"max": "1",
"short": "Text summary of the resource, for human interpretation",
"definition": "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.",
"comment": "",
"inherited": true,
"base": "DomainResource"
},
{
"name": "contained",
"depth": 1,
"types": [
{
"datatype": "Resource"
}
],
"path": "UserSecurityRequest.contained",
"min": 0,
"max": "*",
"short": "Contained, inline Resources",
"definition": "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.",
"comment": "",
"inherited": true,
"base": "DomainResource"
},
{
"name": "extension",
"depth": 1,
"types": [
{
"datatype": "Extension",
"documentLocation": "datatype"
}
],
"path": "UserSecurityRequest.extension",
"min": 0,
"max": "*",
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "",
"inherited": true,
"base": "DomainResource"
},
{
"name": "modifierExtension",
"depth": 1,
"types": [
{
"datatype": "Extension",
"documentLocation": "datatype"
}
],
"path": "UserSecurityRequest.modifierExtension",
"min": 0,
"max": "*",
"short": "Extensions that cannot be ignored",
"definition": "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).",
"comment": "",
"inherited": true,
"base": "DomainResource"
},
{
"name": "type",
"depth": 1,
"types": [
{
"datatype": "code"
}
],
"path": "UserSecurityRequest.type",
"min": 0,
"max": "1",
"short": "",
"definition": "The type of user security request.",
"comment": "",
"inherited": false
},
{
"name": "user",
"depth": 1,
"types": [
{
"datatype": "Reference",
"documentLocation": "datatype"
}
],
"referenceTypes": [
{
"datatype": "User",
"documentLocation": "medplum"
}
],
"path": "UserSecurityRequest.user",
"min": 1,
"max": "1",
"short": "",
"definition": "The user performing the security request.",
"comment": "",
"inherited": false
},
{
"name": "secret",
"depth": 1,
"types": [
{
"datatype": "string"
}
],
"path": "UserSecurityRequest.secret",
"min": 1,
"max": "1",
"short": "",
"definition": "Secret string used to verify the identity of the user.",
"comment": "",
"inherited": false
},
{
"name": "used",
"depth": 1,
"types": [
{
"datatype": "boolean"
}
],
"path": "UserSecurityRequest.used",
"min": 0,
"max": "1",
"short": "",
"definition": "Whether this request has been used, and is therefore no longer valid.",
"comment": "",
"inherited": false
},
{
"name": "redirectUri",
"depth": 1,
"types": [
{
"datatype": "uri"
}
],
"path": "UserSecurityRequest.redirectUri",
"min": 0,
"max": "1",
"short": "",
"definition": "Redirect URI used when redirecting a client back to the client application.",
"comment": "",
"inherited": false
}
],
"searchParameters": [
{
"name": "user",
"type": "reference",
"description": "The user for the security request.",
"expression": "UserSecurityRequest.user"
}
]
}